# Struct ipworkssftp::SFTPServer The SFTPServer struct is used to create a Secure File Transfer Protocol (SFTP) server. ## Syntax ```text ipworkssftp::SFTPServer ``` ## Remarks The SFTPServer struct provides a simple way to create a Secure File Transfer Protocol (SFTP) server. Any SFTP client will be able to connect and transfer files to and from the server. ### Getting Started To begin, first provide a valid certificate with a private key in the ssh_cert property. Optionally set the [root_directory](#root_directory-property-sftpserver-struct) property to a valid local path. If this property is set, the struct will serve files from this location, and when clients connect, they will see this as their initial directory. If this property is not set, then the struct will fire events allowing customized responses for each operation. To start the server, set [listening](#listening-property-sftpserver-struct) to True. ### Client Authentication Client authentication is handled through the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event. Inside this event, the *Accept* parameter determines whether authentication is accepted; this parameter should be set to *True* if a successful authentication is detected and *False* otherwise. When a client connects, the *AuthMethod* parameter indicates the method of authentication the client wishes to use. Connecting clients will initially attempt authentication with an *AuthMethod* of "none". This is done with the expectation that the request will fail and the server will provide a list of support authentication methods. The client then selects an available method and reauthenticates. If *AuthMethod* is "none", *Accept* should be set to *False*. For **password** authentication, the *User* parameter will hold the client's username and the *AuthParam* parameter will hold the password provided by the client. An external list of known usernames and passwords should be maintained to check these values against. For **publickey** authentication, the *User* parameter will hold the client's username and the *AuthParam* parameter will hold the key provided by the client. This key should be compared to an external list of known keys and usernames. For **keyboard-interactive** authentication, the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event will fire multiple times; once for each prompt and response sent by the client. The index of the response is specified as a suffix in the *AuthMethod* parameter (e.g., keyboard-interactive-1, keyboard-interactive-2), and *AuthParam* will contain the client's response to the prompt. Finally, [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) will fire one last time with *AuthMethod* set to "keyboard-interactive" and *AuthParam* set to an empty string. The *Accept* parameter must be set to *True* each time the event fires for the authentication process to succeed. ### Directory Listing When a client requests a directory listing, the [on_dir_list](#on_dir_list-event-sftpserver-struct) event fires with the *Path* parameter set to the directory to enumerate. If the directory listing is allowed, the appropriate set of files should be passed to the [set_file_list](#set_file_list-method-sftpserver-struct) method. The *StatusCode* parameter should be set according to the status of the operation, and the valid status codes can be found in the documentation for the [on_dir_list](#on_dir_list-event-sftpserver-struct) event. ### Handling Events Event handlers are the primary method of customizing the struct's functionality. When a client attempts to connect, open a file, authenticate to the server, and so on, the corresponding SFTPServer event will fire to allow for custom handling of the client's request. The following events are fired **both before and after** the requested operation is executed: - [on_dir_create](#on_dir_create-event-sftpserver-struct) - [on_dir_list](#on_dir_list-event-sftpserver-struct) - [on_dir_remove](#on_dir_remove-event-sftpserver-struct) - [on_file_open](#on_file_open-event-sftpserver-struct) - [on_file_remove](#on_file_remove-event-sftpserver-struct) - [on_file_rename](#on_file_rename-event-sftpserver-struct) - [on_file_write](#on_file_write-event-sftpserver-struct) - [on_set_attributes](#on_set_attributes-event-sftpserver-struct) Each of these events has a *BeforeExec* event parameter that is *True* when the event is fired before execution of the operation, and *False* after execution of the operation. Handling the event before execution provides an opportunity to use custom logic to determine whether the operation should be denied, diverted, or otherwise modified. Handling the event after execution provides an opportunity to report success or any errors related to the operation to the client. The following events are fired only **after** the requested operation is executed: - [on_file_close](#on_file_close-event-sftpserver-struct) - [on_file_read](#on_file_read-event-sftpserver-struct) - [on_get_attributes](#on_get_attributes-event-sftpserver-struct) - [on_resolve_path](#on_resolve_path-event-sftpserver-struct) Any logic to deny opening a file for read or write should be done in the [on_file_open](#on_file_open-event-sftpserver-struct) event handler. NOTE: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, [do_events](#do_events-method-sftpserver-struct) should be called in a loop after the server is started. ### 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 SFTPServer struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SFTPServer 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.* | | | | --- | --- | | [connection_backlog](#connection_backlog-property-sftpserver-struct) | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. | | [sftp_connection_count](#sftp_connection_count-property-sftpserver-struct) | The number of records in the SFTPConnection arrays. | | [sftp_connection_connected](#sftp_connection_connected-property-sftpserver-struct) | This property indicates the status of individual connections. | | [sftp_connection_error_message](#sftp_connection_error_message-property-sftpserver-struct) | ErrorMessage is used together with status codes returned from events to send informative errors back to the secure file transfer protocol (SFTP) client through the SSH_FXP_STATUS message. | | [sftp_connection_file_data](#sftp_connection_file_data-property-sftpserver-struct) | The FileData should be set or read when processing read/write file events. | | [sftp_connection_local_address](#sftp_connection_local_address-property-sftpserver-struct) | This property shows the IP address of the interface through which the connection is passing. | | [sftp_connection_protocol_version](#sftp_connection_protocol_version-property-sftpserver-struct) | The ProtocolVersion shows the secure file transfer protocol (SFTP) protocol version negotiated with the client when the SFTP connection was established. | | [sftp_connection_remote_host](#sftp_connection_remote_host-property-sftpserver-struct) | The RemoteHost shows the IP address of the remote host through which the connection is coming. | | [sftp_connection_remote_port](#sftp_connection_remote_port-property-sftpserver-struct) | The RemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. | | [sftp_connection_timeout](#sftp_connection_timeout-property-sftpserver-struct) | This property contains a timeout for the struct. | | [default_auth_methods](#default_auth_methods-property-sftpserver-struct) | The supported authentication methods. | | [default_timeout](#default_timeout-property-sftpserver-struct) | The initial timeout value to be used by incoming connections. | | [keyboard_interactive_message](#keyboard_interactive_message-property-sftpserver-struct) | The instructions to send to the client during keyboard-interactive authentication. | | [keyboard_interactive_prompt_count](#keyboard_interactive_prompt_count-property-sftpserver-struct) | The number of records in the KeyboardInteractivePrompt arrays. | | [keyboard_interactive_prompt_echo](#keyboard_interactive_prompt_echo-property-sftpserver-struct) | This property specifies whether or not the client should echo the value entered by the user. | | [keyboard_interactive_prompt_prompt](#keyboard_interactive_prompt_prompt-property-sftpserver-struct) | This property contains the prompt label or text the client should present to the user. | | [listening](#listening-property-sftpserver-struct) | This property indicates whether the struct is listening for incoming connections on LocalPort. | | [local_host](#local_host-property-sftpserver-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [local_port](#local_port-property-sftpserver-struct) | The Transmission Control Protocol (TCP) port in the local host where the struct listens. | | [root_directory](#root_directory-property-sftpserver-struct) | The root directory for the entire secure file transfer protocol (SFTP) server. | | [ssh_cert_count](#ssh_cert_count-property-sftpserver-struct) | The number of records in the SSHCert arrays. | | [ssh_cert_effective_date](#ssh_cert_effective_date-property-sftpserver-struct) | The date on which this certificate becomes valid. | | [ssh_cert_expiration_date](#ssh_cert_expiration_date-property-sftpserver-struct) | The date on which the certificate expires. | | [ssh_cert_extended_key_usage](#ssh_cert_extended_key_usage-property-sftpserver-struct) | A comma-delimited list of extended key usage identifiers. | | [ssh_cert_fingerprint](#ssh_cert_fingerprint-property-sftpserver-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssh_cert_fingerprint_sha1](#ssh_cert_fingerprint_sha1-property-sftpserver-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssh_cert_fingerprint_sha256](#ssh_cert_fingerprint_sha256-property-sftpserver-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssh_cert_issuer](#ssh_cert_issuer-property-sftpserver-struct) | The issuer of the certificate. | | [ssh_cert_private_key](#ssh_cert_private_key-property-sftpserver-struct) | The private key of the certificate (if available). | | [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sftpserver-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssh_cert_private_key_container](#ssh_cert_private_key_container-property-sftpserver-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssh_cert_public_key](#ssh_cert_public_key-property-sftpserver-struct) | The public key of the certificate. | | [ssh_cert_public_key_algorithm](#ssh_cert_public_key_algorithm-property-sftpserver-struct) | The textual description of the certificate's public key algorithm. | | [ssh_cert_public_key_length](#ssh_cert_public_key_length-property-sftpserver-struct) | The length of the certificate's public key (in bits). | | [ssh_cert_serial_number](#ssh_cert_serial_number-property-sftpserver-struct) | The serial number of the certificate encoded as a string. | | [ssh_cert_signature_algorithm](#ssh_cert_signature_algorithm-property-sftpserver-struct) | The text description of the certificate's signature algorithm. | | [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct) | The name of the certificate store for the client certificate. | | [ssh_cert_store_password](#ssh_cert_store_password-property-sftpserver-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-sftpserver-struct) | The type of certificate store for this certificate. | | [ssh_cert_subject_alt_names](#ssh_cert_subject_alt_names-property-sftpserver-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssh_cert_thumbprint_md5](#ssh_cert_thumbprint_md5-property-sftpserver-struct) | The MD5 hash of the certificate. | | [ssh_cert_thumbprint_sha1](#ssh_cert_thumbprint_sha1-property-sftpserver-struct) | The SHA-1 hash of the certificate. | | [ssh_cert_thumbprint_sha256](#ssh_cert_thumbprint_sha256-property-sftpserver-struct) | The SHA-256 hash of the certificate. | | [ssh_cert_usage](#ssh_cert_usage-property-sftpserver-struct) | The text description of UsageFlags . | | [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpserver-struct) | The flags that show intended use for the certificate. | | [ssh_cert_version](#ssh_cert_version-property-sftpserver-struct) | The certificate's version number. | | [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) | The subject of the certificate used for client authentication. | | [ssh_cert_encoded](#ssh_cert_encoded-property-sftpserver-struct) | The certificate (PEM/Base64 encoded). | | [ssh_compression_algorithms](#ssh_compression_algorithms-property-sftpserver-struct) | The comma-separated list containing all allowable compression algorithms. | | [ssh_encryption_algorithms](#ssh_encryption_algorithms-property-sftpserver-struct) | The comma-separated list containing all allowable encryption algorithms. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [config](#config-method-sftpserver-struct) | Sets or retrieves a configuration setting. | | [disconnect](#disconnect-method-sftpserver-struct) | This method disconnects the specified client. | | [do_events](#do_events-method-sftpserver-struct) | This method processes events from the internal message queue. | | [exchange_keys](#exchange_keys-method-sftpserver-struct) | Causes the struct to exchange a new set of session keys on the specified connection. | | [reset](#reset-method-sftpserver-struct) | This method will reset the struct. | | [set_file_list](#set_file_list-method-sftpserver-struct) | Sets the file list for a connection during a directory listing request. | | [shutdown](#shutdown-method-sftpserver-struct) | This method shuts down the server. | | [start_listening](#start_listening-method-sftpserver-struct) | This method starts listening for incoming connections. | | [stop_listening](#stop_listening-method-sftpserver-struct) | This method stops listening for new connections. | ## 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-sftpserver-struct) | Fired immediately after a connection completes (or fails). | | [on_connection_request](#on_connection_request-event-sftpserver-struct) | This event is fired when a request for connection comes from a remote host. | | [on_dir_create](#on_dir_create-event-sftpserver-struct) | Fired when a client wants to create a new directory. | | [on_dir_list](#on_dir_list-event-sftpserver-struct) | Fired when a client attempts to open a directory for listing. | | [on_dir_remove](#on_dir_remove-event-sftpserver-struct) | Fired when a client wants to delete a directory. | | [on_disconnected](#on_disconnected-event-sftpserver-struct) | This event is fired when a connection is closed. | | [on_error](#on_error-event-sftpserver-struct) | Fired when errors occur during data delivery. | | [on_file_close](#on_file_close-event-sftpserver-struct) | Fired when a client attempts to close an open file or directory handle. | | [on_file_open](#on_file_open-event-sftpserver-struct) | Fired when a client wants to open or create a file. | | [on_file_read](#on_file_read-event-sftpserver-struct) | Fired when a client wants to read from an open file. | | [on_file_remove](#on_file_remove-event-sftpserver-struct) | Fired when a client wants to delete a file. | | [on_file_rename](#on_file_rename-event-sftpserver-struct) | Fired when a client wants to rename a file. | | [on_file_write](#on_file_write-event-sftpserver-struct) | Fired when a client wants to write to an open file. | | [on_get_attributes](#on_get_attributes-event-sftpserver-struct) | Fired when a client needs to get file information. | | [on_log](#on_log-event-sftpserver-struct) | Fired once for each log message. | | [on_resolve_path](#on_resolve_path-event-sftpserver-struct) | Fired when a client attempts to canonicalize a path. | | [on_set_attributes](#on_set_attributes-event-sftpserver-struct) | Fired when a client attempts to set file or directory attributes. | | [on_ssh_status](#on_ssh_status-event-sftpserver-struct) | Fired to track the progress of the secure connection. | | [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) | Fired when a client attempts to authenticate a connection. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DirListBufferSize\[ConnectionId\]](#DirListBufferSize[ConnectionId]) | The number of entries to be returned in one response to a request for a directory listing. | | [MaskSensitiveData](#MaskSensitiveData) | Masks passwords in logs. | | [MaxStartupsConnections](#MaxStartupsConnections) | The number of unauthenticated connections that the server will accept. | | [ProtocolVersion](#ProtocolVersion) | The highest allowable SFTP version to use. | | [RestrictUserToHomeDir\[ConnectionId\]](#RestrictUserToHomeDir[ConnectionId]) | Whether to restrict the user to their home directory. | | [ServerEOL](#ServerEOL) | Specifies the line endings used in files on the server. | | [SFTPErrorMessage\[ConnectionId\]](#SFTPErrorMessage[ConnectionId]) | Specifies the error message to be returned to the client. | | [UnixStyleDateFormat](#UnixStyleDateFormat) | Controls whether to use the Unix-style date format in directory listings. | | [UserRootDirectory\[ConnectionId\]](#UserRootDirectory[ConnectionId]) | The path of the server root directory for a particular user. | | [AltSSHCertCount](#AltSSHCertCount) | The number of records in the AltSSHCert configuration settings. | | [AltSSHCertStore\[i\]](#AltSSHCertStore[i]) | The name of the certificate store. | | [AltSSHCertStorePassword\[i\]](#AltSSHCertStorePassword[i]) | The password used to open the certificate store. | | [AltSSHCertStoreType\[i\]](#AltSSHCertStoreType[i]) | The type of certificate store. | | [AltSSHCertSubject\[i\]](#AltSSHCertSubject[i]) | The alternative certificate subject. | | [ClientSSHVersionString\[ConnectionId\]](#ClientSSHVersionString[ConnectionId]) | The client's version string. | | [FireAuthRequestAfterSig](#FireAuthRequestAfterSig) | Whether to fire an informational event after the public key signature has been verified. | | [KeyboardInteractivePrompts\[ConnectionId\]](#KeyboardInteractivePrompts[ConnectionId]) | Specifies custom keyboard-interactive prompts for particular connections. | | [KeyRenegotiationThreshold](#KeyRenegotiationThreshold) | Sets the threshold for the SSH Key Renegotiation. | | [LogLevel](#LogLevel) | Specifies the level of detail that is logged. | | [MaxAuthAttempts](#MaxAuthAttempts) | The maximum authentication attempts allowed before forcing a disconnect. | | [NegotiatedStrictKex\[ConnectionId\]](#NegotiatedStrictKex[ConnectionId]) | Returns whether strict key exchange was negotiated to be used. | | [ServerSSHVersionString](#ServerSSHVersionString) | The SSH version string sent to connecting clients. | | [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. | | [SSHMacAlgorithms](#SSHMacAlgorithms) | Specifies the supported Mac algorithms. | | [SSHPubKeyAuthSigAlgorithms](#SSHPubKeyAuthSigAlgorithms) | Specifies the allowed signature algorithms used by a client performing 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. | | [UserAuthBanner\[ConnectionId\]](#UserAuthBanner[ConnectionId]) | A custom user authentication banner. | | [UseStrictKeyExchange](#UseStrictKeyExchange) | Specifies how strict key exchange is supported. | | [AllowedClients](#AllowedClients) | A comma-separated list of host names or IP addresses that can access the struct. | | [BindExclusively](#BindExclusively) | Whether or not the struct considers a local port reserved for exclusive use. | | [BlockedClients](#BlockedClients) | A comma-separated list of host names or IP addresses that cannot access the struct. | | [DefaultConnectionTimeout](#DefaultConnectionTimeout) | The inactivity timeout applied to the SSL handshake. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [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. | | [MaxConnections](#MaxConnections) | The maximum number of connections available. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [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. | # connection_backlog property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. ## Syntax *Rust Syntax* ```text fn connection_backlog(&self ) -> Result fn set_connection_backlog(&self, value : i32) -> Option ``` ## Default Value 5 ## Remarks This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable. ## Data Type i32 # sftp_connection_count property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The number of records in the SFTPConnection arrays. ## Syntax *Rust Syntax* ```text fn sftp_connection_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [sftp_connection_connected](#sftp_connection_connected-property-sftpserver-struct) - [sftp_connection_error_message](#sftp_connection_error_message-property-sftpserver-struct) - [sftp_connection_file_data](#sftp_connection_file_data-property-sftpserver-struct) - [sftp_connection_local_address](#sftp_connection_local_address-property-sftpserver-struct) - [sftp_connection_protocol_version](#sftp_connection_protocol_version-property-sftpserver-struct) - [sftp_connection_remote_host](#sftp_connection_remote_host-property-sftpserver-struct) - [sftp_connection_remote_port](#sftp_connection_remote_port-property-sftpserver-struct) - [sftp_connection_timeout](#sftp_connection_timeout-property-sftpserver-struct) The array indices start at *0* and end at *sftp_connection_count - 1*. This property is read-only. ## Data Type i32 # sftp_connection_connected property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property indicates the status of individual connections. ## Syntax *Rust Syntax* ```text fn sftp_connection_connected(&self , ConnectionId : i32) -> Result ``` ## Default Value false ## Remarks This property indicates the status of individual connections. When *true*, the connection is established. Use the disconnect method to disconnect an existing connection. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. This property is read-only. ## Data Type bool # sftp_connection_error_message property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) ErrorMessage is used together with status codes returned from events to send informative errors back to the secure file transfer protocol (SFTP) client through the SSH_FXP_STATUS message. ## Syntax *Rust Syntax* ```text fn sftp_connection_error_message(&self , ConnectionId : i32) -> Result ``` ## Default Value "" ## Remarks [sftp_connection_error_message](#sftp_connection_error_message-property-sftpserver-struct) is used together with status codes returned from events to send informative errors back to the secure file transfer protocol (SFTP) client through the SSH_FXP_STATUS message. If left blank, the struct will set a default message based on the returned status code. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # sftp_connection_file_data property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The FileData should be set or read when processing read/write file events. ## Syntax *Rust Syntax* ```text fn sftp_connection_file_data(&self , ConnectionId : i32) -> Result, IPWorksSFTPError> fn set_sftp_connection_file_data(&self, ConnectionId : i32, value : Vec) -> Option fn set_sftp_connection_file_data_ref(&self, ConnectionId : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The [sftp_connection_file_data](#sftp_connection_file_data-property-sftpserver-struct) should be set or read when processing read/write file events. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. ## Data Type Vec # sftp_connection_local_address property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property shows the IP address of the interface through which the connection is passing. ## Syntax *Rust Syntax* ```text fn sftp_connection_local_address(&self , ConnectionId : i32) -> Result ``` ## Default Value "" ## Remarks This property shows the IP address of the interface through which the connection is passing. [sftp_connection_local_address](#sftp_connection_local_address-property-sftpserver-struct) is important for multihomed hosts in cases in which it can be used to identify the particular network interface an individual connection is going through. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # sftp_connection_protocol_version property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The ProtocolVersion shows the secure file transfer protocol (SFTP) protocol version negotiated with the client when the SFTP connection was established. ## Syntax *Rust Syntax* ```text fn sftp_connection_protocol_version(&self , ConnectionId : i32) -> Result ``` ## Default Value 3 ## Remarks The [sftp_connection_protocol_version](#sftp_connection_protocol_version-property-sftpserver-struct) shows the secure file transfer protocol (SFTP) protocol version negotiated with the client when the SFTP connection was established. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. This property is read-only. ## Data Type i32 # sftp_connection_remote_host property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The RemoteHost shows the IP address of the remote host through which the connection is coming. ## Syntax *Rust Syntax* ```text fn sftp_connection_remote_host(&self , ConnectionId : i32) -> Result ``` ## Default Value "" ## Remarks The [sftp_connection_remote_host](#sftp_connection_remote_host-property-sftpserver-struct) shows the IP address of the remote host through which the connection is coming. The connection must be valid or an error will be fired. If the struct is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # sftp_connection_remote_port property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The RemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. ## Syntax *Rust Syntax* ```text fn sftp_connection_remote_port(&self , ConnectionId : i32) -> Result ``` ## Default Value 0 ## Remarks The [sftp_connection_remote_port](#sftp_connection_remote_port-property-sftpserver-struct) shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. The connection must be valid or an error will be fired. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. This property is read-only. ## Data Type i32 # sftp_connection_timeout property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property contains a timeout for the struct. ## Syntax *Rust Syntax* ```text fn sftp_connection_timeout(&self , ConnectionId : i32) -> Result fn set_sftp_connection_timeout(&self, ConnectionId : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property contains a timeout for the struct. If the timeout property is set to 0, all operations return immediately, potentially failing with an *'WOULDBLOCK'* error if data cannot be sent or received immediately. If timeout is set to a positive value, the struct will automatically retry each operation that otherwise would result in a *'WOULDBLOCK'* error for a maximum of timeout seconds. The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If timeout expires, and the operation is not yet complete, the 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 0 (asynchronous operation). The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [SFTPConnectionCount](#sftp_connection_count-property-sftpserver-struct) property. ## Data Type i32 # default_auth_methods property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The supported authentication methods. ## Syntax *Rust Syntax* ```text fn default_auth_methods(&self ) -> Result fn set_default_auth_methods(&self, value : &str) -> Option fn set_default_auth_methods_ref(&self, value : &String) -> Option ``` ## Default Value "password,publickey" ## Remarks This property specifies the supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the struct. This must be a comma-separated list of values. For more information on authenticating clients, see the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event. The following is a list of methods implemented by the struct: | | | | --- | --- | | none | This authentication method is used by most Secure Shell (SSH) clients to obtain the list of authentication methods available for the user's account. In most cases, you should not accept a request using this authentication method. | | password | AuthParam will contain the user-supplied password. If the password is correct, set Accept to True. | | publickey | AuthParam will contain an SSH2 public key blob. If the user's public key is acceptable, set Accept or PartialSuccess to true. The struct will then handle verifying the digital signature and will respond to the client accordingly. | | keyboard-interactive | [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) will fire multiple times for keyboard-interactive authentication: It will fire once for each response sent by the client in the SSH_MSG_USERAUTH_INFO_RESPONSE packet (one time for each prompt specified by the daemon). The index of each response will be specified as a suffix in AuthMethod, with AuthParam containing the response to the corresponding prompt (e.g., keyboard-interactive-1, keyboard-interactive-2, and so on). Finally, [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) will fire one last time with AuthMethod set to "keyboard-interactive" and AuthParam set to an empty string. The daemon must set Accept to True every time to allow the authentication process to succeed. | ## Data Type String # default_timeout property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The initial timeout value to be used by incoming connections. ## Syntax *Rust Syntax* ```text fn default_timeout(&self ) -> Result fn set_default_timeout(&self, value : i32) -> Option ``` ## Default Value 60 ## Remarks This property is used by the struct to set the operational timeout value of all inbound connections once they are established. If the timeout is set to 0, all inbound connections will behave asynchronously. The default value is 60, meaning the struct will behave synchronously. ## Data Type i32 # keyboard_interactive_message property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The instructions to send to the client during keyboard-interactive authentication. ## Syntax *Rust Syntax* ```text fn keyboard_interactive_message(&self ) -> Result fn set_keyboard_interactive_message(&self, value : &str) -> Option fn set_keyboard_interactive_message_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property should be set to the main instructions to send to the client during keyboard-interactive authentication. ## Data Type String # keyboard_interactive_prompt_count property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The number of records in the KeyboardInteractivePrompt arrays. ## Syntax *Rust Syntax* ```text fn keyboard_interactive_prompt_count(&self ) -> Result fn set_keyboard_interactive_prompt_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [keyboard_interactive_prompt_echo](#keyboard_interactive_prompt_echo-property-sftpserver-struct) - [keyboard_interactive_prompt_prompt](#keyboard_interactive_prompt_prompt-property-sftpserver-struct) The array indices start at *0* and end at *keyboard_interactive_prompt_count - 1*. ## Data Type i32 # keyboard_interactive_prompt_echo property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property specifies whether or not the client should echo the value entered by the user. ## Syntax *Rust Syntax* ```text fn keyboard_interactive_prompt_echo(&self , PromptIndex : i32) -> Result fn set_keyboard_interactive_prompt_echo(&self, PromptIndex : i32, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether or not the client should echo the value entered by the user. The *PromptIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KeyboardInteractivePromptCount](#keyboard_interactive_prompt_count-property-sftpserver-struct) property. ## Data Type bool # keyboard_interactive_prompt_prompt property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property contains the prompt label or text the client should present to the user. ## Syntax *Rust Syntax* ```text fn keyboard_interactive_prompt_prompt(&self , PromptIndex : i32) -> Result fn set_keyboard_interactive_prompt_prompt(&self, PromptIndex : i32, value : &str) -> Option fn set_keyboard_interactive_prompt_prompt_ref(&self, PromptIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks This property contains the prompt label or text the client should present to the user. The *PromptIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KeyboardInteractivePromptCount](#keyboard_interactive_prompt_count-property-sftpserver-struct) property. ## Data Type String # listening property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This property indicates whether the struct is listening for incoming connections on LocalPort. ## Syntax *Rust Syntax* ```text fn listening(&self ) -> Result ``` ## Default Value false ## Remarks This property indicates whether the struct is listening for connections on the port specified by the [local_port](#local_port-property-sftpserver-struct) property. Use the [start_listening](#start_listening-method-sftpserver-struct) and [stop_listening](#stop_listening-method-sftpserver-struct) methods to control whether the struct is listening. This property is read-only. ## Data Type bool # local_host property ([SFTPServer](#struct-ipworkssftpsftpserver) 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 ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The Transmission Control Protocol (TCP) port in the local host where the struct listens. ## Syntax *Rust Syntax* ```text fn local_port(&self ) -> Result fn set_local_port(&self, value : i32) -> Option ``` ## Default Value 22 ## Remarks The local_port property must be set before TCPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of the local_port property after TCPServer is in listening mode (after successfully assigning True to the [listening](#listening-property-sftpserver-struct) property). NOTE: The service port is not shared among servers (i.e., only one TCPServer can be 'listening' on a particular port at one time). ## Data Type i32 # root_directory property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The root directory for the entire secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn root_directory(&self ) -> Result fn set_root_directory(&self, value : &str) -> Option fn set_root_directory_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks root_directory specifies the root of the SFTP server ('/'). If a value is provided, the struct will handle all requests by doing all file operations itself, but the events will still give you the opportunity to override the default values and operations, as necessary. If a value is not provided, all events must be handled appropriately to ensure correct operation. ## Data Type String # ssh_cert_count property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The number of records in the SSHCert arrays. ## Syntax *Rust Syntax* ```text fn ssh_cert_count(&self ) -> Result fn set_ssh_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ssh_cert_effective_date](#ssh_cert_effective_date-property-sftpserver-struct) - [ssh_cert_encoded](#ssh_cert_encoded-property-sftpserver-struct) - [ssh_cert_expiration_date](#ssh_cert_expiration_date-property-sftpserver-struct) - [ssh_cert_extended_key_usage](#ssh_cert_extended_key_usage-property-sftpserver-struct) - [ssh_cert_fingerprint](#ssh_cert_fingerprint-property-sftpserver-struct) - [ssh_cert_fingerprint_sha1](#ssh_cert_fingerprint_sha1-property-sftpserver-struct) - [ssh_cert_fingerprint_sha256](#ssh_cert_fingerprint_sha256-property-sftpserver-struct) - [ssh_cert_issuer](#ssh_cert_issuer-property-sftpserver-struct) - [ssh_cert_private_key](#ssh_cert_private_key-property-sftpserver-struct) - [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sftpserver-struct) - [ssh_cert_private_key_container](#ssh_cert_private_key_container-property-sftpserver-struct) - [ssh_cert_public_key](#ssh_cert_public_key-property-sftpserver-struct) - [ssh_cert_public_key_algorithm](#ssh_cert_public_key_algorithm-property-sftpserver-struct) - [ssh_cert_public_key_length](#ssh_cert_public_key_length-property-sftpserver-struct) - [ssh_cert_serial_number](#ssh_cert_serial_number-property-sftpserver-struct) - [ssh_cert_signature_algorithm](#ssh_cert_signature_algorithm-property-sftpserver-struct) - [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct) - [ssh_cert_store_password](#ssh_cert_store_password-property-sftpserver-struct) - [ssh_cert_store_type](#ssh_cert_store_type-property-sftpserver-struct) - [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) - [ssh_cert_subject_alt_names](#ssh_cert_subject_alt_names-property-sftpserver-struct) - [ssh_cert_thumbprint_md5](#ssh_cert_thumbprint_md5-property-sftpserver-struct) - [ssh_cert_thumbprint_sha1](#ssh_cert_thumbprint_sha1-property-sftpserver-struct) - [ssh_cert_thumbprint_sha256](#ssh_cert_thumbprint_sha256-property-sftpserver-struct) - [ssh_cert_usage](#ssh_cert_usage-property-sftpserver-struct) - [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpserver-struct) - [ssh_cert_version](#ssh_cert_version-property-sftpserver-struct) The array indices start at *0* and end at *ssh_cert_count - 1*. ## Data Type i32 # ssh_cert_effective_date property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssh_cert_effective_date(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_expiration_date property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssh_cert_expiration_date(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_extended_key_usage property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssh_cert_extended_key_usage(&self , SSHCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_fingerprint property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint(&self , SSHCertIndex : i32) -> 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* The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_fingerprint_sha1 property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint_sha1(&self , SSHCertIndex : i32) -> 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* The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_fingerprint_sha256 property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint_sha256(&self , SSHCertIndex : i32) -> 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* The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_issuer property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_issuer(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_private_key property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key(&self , SSHCertIndex : i32) -> 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-sftpserver-struct) may be available but not exportable. In this case, [ssh_cert_private_key](#ssh_cert_private_key-property-sftpserver-struct) returns an empty string. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_private_key_available property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key_available(&self , SSHCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [ssh_cert_private_key](#ssh_cert_private_key-property-sftpserver-struct) is available for the selected certificate. If [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sftpserver-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type bool # ssh_cert_private_key_container property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key_container(&self , SSHCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [ssh_cert_private_key](#ssh_cert_private_key-property-sftpserver-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_public_key property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key(&self , SSHCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_public_key_algorithm property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key_algorithm(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_public_key_length property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key_length(&self , SSHCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type i32 # ssh_cert_serial_number property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssh_cert_serial_number(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_signature_algorithm property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssh_cert_signature_algorithm(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_store property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_store(&self , SSHCertIndex : i32) -> Result, IPWorksSFTPError> fn set_ssh_cert_store(&self, SSHCertIndex : i32, value : Vec) -> Option fn set_ssh_cert_store_ref(&self, SSHCertIndex : i32, 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-sftpserver-struct) property denotes the type of the certificate store specified by [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct). If the store is password-protected, specify the password in [ssh_cert_store_password](#ssh_cert_store_password-property-sftpserver-struct). [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct) is used in conjunction with the [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) property to specify client certificates. If [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct) has a value, and [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) or [ssh_cert_encoded](#ssh_cert_encoded-property-sftpserver-struct) is set, a search for a certificate is initiated. Please see the [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-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). The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. ## Data Type Vec # ssh_cert_store_password property ([SFTPServer](#struct-ipworkssftpsftpserver) 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 , SSHCertIndex : i32) -> Result fn set_ssh_cert_store_password(&self, SSHCertIndex : i32, value : &str) -> Option fn set_ssh_cert_store_password_ref(&self, SSHCertIndex : i32, 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. ## Data Type String # ssh_cert_store_type property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_store_type(&self , SSHCertIndex : i32) -> Result fn set_ssh_cert_store_type(&self, SSHCertIndex : i32, 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-sftpserver-struct), the full path of the PKCS#11 DLL as the [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct), and the PIN as the [ssh_cert_store_password](#ssh_cert_store_password-property-sftpserver-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-sftpserver-struct) and set [ssh_cert_store_password](#ssh_cert_store_password-property-sftpserver-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. | The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. ## Data Type i32 # ssh_cert_subject_alt_names property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_subject_alt_names(&self , SSHCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_thumbprint_md5 property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_md5(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_thumbprint_sha1 property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_sha1(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_thumbprint_sha256 property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_sha256(&self , SSHCertIndex : i32) -> 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_usage property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssh_cert_usage(&self , SSHCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpserver-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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_usage_flags property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_usage_flags(&self , SSHCertIndex : i32) -> 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-sftpserver-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-sftpserver-struct) property for a text representation of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpserver-struct). This functionality currently is not available when the provider is OpenSSL. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type i32 # ssh_cert_version property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssh_cert_version(&self , SSHCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. This property is read-only. ## Data Type String # ssh_cert_subject property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssh_cert_subject(&self , SSHCertIndex : i32) -> Result fn set_ssh_cert_subject(&self, SSHCertIndex : i32, value : &str) -> Option fn set_ssh_cert_subject_ref(&self, SSHCertIndex : i32, 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. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. ## Data Type String # ssh_cert_encoded property ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssh_cert_encoded(&self , SSHCertIndex : i32) -> Result, IPWorksSFTPError> fn set_ssh_cert_encoded(&self, SSHCertIndex : i32, value : Vec) -> Option fn set_ssh_cert_encoded_ref(&self, SSHCertIndex : i32, 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-sftpserver-struct) and [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) properties also may be used to specify a certificate. When [ssh_cert_encoded](#ssh_cert_encoded-property-sftpserver-struct) is set, a search is initiated in the current [ssh_cert_store](#ssh_cert_store-property-sftpserver-struct) for the private key of the certificate. If the key is found, [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssh_cert_subject](#ssh_cert_subject-property-sftpserver-struct) is set to an empty string. The *SSHCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SSHCertCount](#ssh_cert_count-property-sftpserver-struct) property. ## Data Type Vec # ssh_compression_algorithms property ([SFTPServer](#struct-ipworkssftpsftpserver) 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 ([SFTPServer](#struct-ipworkssftpsftpserver) 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 # config method ([SFTPServer](#struct-ipworkssftpsftpserver) 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-sftpserver-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-sftpserver-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # disconnect method ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This method disconnects the specified client. ## Syntax *Rust Syntax* ```text fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksSFTPError> ``` ## Remarks Calling this method will disconnect the client specified by the *connection_id* parameter. # do_events method ([SFTPServer](#struct-ipworkssftpsftpserver) 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. # exchange_keys method ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Causes the struct to exchange a new set of session keys on the specified connection. ## Syntax *Rust Syntax* ```text fn exchange_keys(&self, connection_id : i32) -> Result<(), IPWorksSFTPError> ``` ## Remarks Secure Shell (SSH) key renegotiation can be initiated by either end of an established SSH connection. exchange_keys allows the server to start such a renegotiation with the client. During this process, [on_ssh_status](#on_ssh_status-event-sftpserver-struct) events will fire with updates about the key negotiation process. The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. This makes it more difficult to break the security of data-intensive or long-lived connections. # reset method ([SFTPServer](#struct-ipworkssftpsftpserver) 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. # set_file_list method ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Sets the file list for a connection during a directory listing request. ## Syntax *Rust Syntax* ```text fn set_file_list(&self, connection_id : i32, list : &String) -> Result<(), IPWorksSFTPError> ``` ## Remarks set_file_list should be set when a directory listing is requested by the client. The list parameter should be a string of all the filenames to include, separated by CRLF. # shutdown method ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This method shuts down the server. ## Syntax *Rust Syntax* ```text fn shutdown(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [stop_listening](#stop_listening-method-sftpserver-struct) and then breaking every client connection by calling [disconnect](#disconnect-method-sftpserver-struct). # start_listening method ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This method starts listening for incoming connections. ## Syntax *Rust Syntax* ```text fn start_listening(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method begins listening for incoming connections on the port specified by [local_port](#local_port-property-sftpserver-struct). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [stop_listening](#stop_listening-method-sftpserver-struct). To stop listening for new connections and to disconnect all existing clients, call [shutdown](#shutdown-method-sftpserver-struct). # stop_listening method ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This method stops listening for new connections. ## Syntax *Rust Syntax* ```text fn stop_listening(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections. To stop listening and to disconnect all existing clients, call [shutdown](#shutdown-method-sftpserver-struct) instead. # on_connected event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired immediately after a connection completes (or fails). ## Syntax *Rust Syntax* ```text // SFTPServerConnectedEventArgs carries the SFTPServer Connected event's parameters. pub struct SFTPServerConnectedEventArgs { fn connection_id(&self) -> i32 fn status_code(&self) -> i32 fn description(&self) -> &String fn cert_store_type(&self) -> i32 fn set_cert_store_type(&self, value : i32) fn cert_store(&self) -> &String fn set_cert_store(&self, value : &str) fn set_cert_store_ref(&self, value : &String) fn cert_password(&self) -> &String fn set_cert_password(&self, value : &str) fn set_cert_password_ref(&self, value : &String) fn cert_subject(&self) -> &String fn set_cert_subject(&self, value : &str) fn set_cert_subject_ref(&self, value : &String) } // SFTPServerConnectedEvent defines the signature of the SFTPServer Connected event's handler function. pub trait SFTPServerConnectedEvent { fn on_connected(&self, sender : SFTPServer, e : &mut SFTPServerConnectedEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_connected(&self) -> &'a dyn SFTPServerConnectedEvent; pub fn set_on_connected(&mut self, value : &'a dyn SFTPServerConnectedEvent); ... } ``` ## Remarks If the connection is made normally, *StatusCode* is 0, and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the system. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-sftpserver-struct) section for more information. *ConnectionId* is the connection Id of the client requesting the connection. *CertStoreType* is the store type of the alternate certificate to use for this connection. The 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 object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) struct by calling the [list_store_certificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | *CertStore* is the store name or location of the alternate certificate to use for this connection. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | 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). *CertPassword* is the password of the certificate store containing the alternate certificate to use for this connection. *CertSubject* is the subject of the alternate certificate to use for this connection. The special value *** matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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. # on_connection_request event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This event is fired when a request for connection comes from a remote host. ## Syntax *Rust Syntax* ```text // SFTPServerConnectionRequestEventArgs carries the SFTPServer ConnectionRequest event's parameters. pub struct SFTPServerConnectionRequestEventArgs { fn address(&self) -> &String fn port(&self) -> i32 fn accept(&self) -> bool fn set_accept(&self, value : bool) } // SFTPServerConnectionRequestEvent defines the signature of the SFTPServer ConnectionRequest event's handler function. pub trait SFTPServerConnectionRequestEvent { fn on_connection_request(&self, sender : SFTPServer, e : &mut SFTPServerConnectionRequestEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_connection_request(&self) -> &'a dyn SFTPServerConnectionRequestEvent; pub fn set_on_connection_request(&mut self, value : &'a dyn SFTPServerConnectionRequestEvent); ... } ``` ## Remarks This event indicates an incoming connection. The connection is accepted by default. *address* and *port* will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the *accept* parameter to False. # on_dir_create event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to create a new directory. ## Syntax *Rust Syntax* ```text // SFTPServerDirCreateEventArgs carries the SFTPServer DirCreate event's parameters. pub struct SFTPServerDirCreateEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn file_type(&self) -> i32 fn file_size(&self) -> i64 fn file_owner(&self) -> &String fn file_group(&self) -> &String fn file_permissions(&self) -> i32 fn file_a_time(&self) -> i64 fn file_create_time(&self) -> i64 fn file_m_time(&self) -> i64 fn file_attrib_bits(&self) -> i32 fn file_attrib_bits_valid(&self) -> i32 fn other_attributes(&self) -> &String fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerDirCreateEvent defines the signature of the SFTPServer DirCreate event's handler function. pub trait SFTPServerDirCreateEvent { fn on_dir_create(&self, sender : SFTPServer, e : &mut SFTPServerDirCreateEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_dir_create(&self) -> &'a dyn SFTPServerDirCreateEvent; pub fn set_on_dir_create(&mut self, value : &'a dyn SFTPServerDirCreateEvent); ... } ``` ## Remarks The *Path* parameter specifies the path and name of the new directory. This event is fired both before and after the directory is created. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. File/Directory Attributes are specified using the following values: *FileType*: The type of file. Can be one of the following values: - SSH_FILEXFER_TYPE_REGULAR (1) - SSH_FILEXFER_TYPE_DIRECTORY (2) - SSH_FILEXFER_TYPE_SYMLINK (3) - SSH_FILEXFER_TYPE_SPECIAL (4) - SSH_FILEXFER_TYPE_UNKNOWN (5) - SSH_FILEXFER_TYPE_SOCKET (6) - SSH_FILEXFER_TYPE_CHAR_DEVICE (7) - SSH_FILEXFER_TYPE_BLOCK_DEVICE (8) - SSH_FILEXFER_TYPE_FIFO (9) *FileSize*: The file size, in bytes. *FileOwner*: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string. *FileGroup*: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string. *FilePermissions*: The POSIX-style file permissions. *FileATime*: The file last-access time, in milliseconds since January 1, 1970, in UTC. *FileCreateTime*: The file creation time, in milliseconds since January 1, 1970, in UTC. *FileMTime*: The file last-modified time, in milliseconds since January 1, 1970, in UTC. *FileAttrBits*: The file attributes, as a combination of the following values: - SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001) - SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002) - SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004) - SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008) - SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010) - SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020) - SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040) - SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080) - SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100) - SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200) - SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400) - SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800) *FileAttrBitsValid*: A mask specifying which bits in *FileAttrBits* are supported by the server. *OtherAttributes*: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following: - MIMEType (String) - AllocationSize (64-bit int) - ATimeNS (int): ATime nanoseconds - CreateTimeNS (int): CreateTime nanoseconds - MTimeNS (int): MTime nanoseconds - TextHint (8-bit int) - LinkCount (int) - UntranslatedName (String) *FileMimeType*: The MIME type of the file. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_dir_list event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client attempts to open a directory for listing. ## Syntax *Rust Syntax* ```text // SFTPServerDirListEventArgs carries the SFTPServer DirList event's parameters. pub struct SFTPServerDirListEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerDirListEvent defines the signature of the SFTPServer DirList event's handler function. pub trait SFTPServerDirListEvent { fn on_dir_list(&self, sender : SFTPServer, e : &mut SFTPServerDirListEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_dir_list(&self) -> &'a dyn SFTPServerDirListEvent; pub fn set_on_dir_list(&mut self, value : &'a dyn SFTPServerDirListEvent); ... } ``` ## Remarks The on_dir_list event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_OPENDIR request. The *Path* parameter will contain the path of the directory to list. When necessary, you should call [set_file_list](#set_file_list-method-sftpserver-struct) with the list of files and directories in *Path*. This event is fired both before and after the directory is listed. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_dir_remove event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to delete a directory. ## Syntax *Rust Syntax* ```text // SFTPServerDirRemoveEventArgs carries the SFTPServer DirRemove event's parameters. pub struct SFTPServerDirRemoveEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerDirRemoveEvent defines the signature of the SFTPServer DirRemove event's handler function. pub trait SFTPServerDirRemoveEvent { fn on_dir_remove(&self, sender : SFTPServer, e : &mut SFTPServerDirRemoveEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_dir_remove(&self) -> &'a dyn SFTPServerDirRemoveEvent; pub fn set_on_dir_remove(&mut self, value : &'a dyn SFTPServerDirRemoveEvent); ... } ``` ## Remarks The *Path* parameter will specify the directory to delete. This event is fired both before and after the directory is deleted. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_disconnected event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) This event is fired when a connection is closed. ## Syntax *Rust Syntax* ```text // SFTPServerDisconnectedEventArgs carries the SFTPServer Disconnected event's parameters. pub struct SFTPServerDisconnectedEventArgs { fn connection_id(&self) -> i32 fn status_code(&self) -> i32 fn description(&self) -> &String } // SFTPServerDisconnectedEvent defines the signature of the SFTPServer Disconnected event's handler function. pub trait SFTPServerDisconnectedEvent { fn on_disconnected(&self, sender : SFTPServer, e : &mut SFTPServerDisconnectedEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_disconnected(&self) -> &'a dyn SFTPServerDisconnectedEvent; pub fn set_on_disconnected(&mut self, value : &'a dyn SFTPServerDisconnectedEvent); ... } ``` ## 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 system. *description* contains a description of this code. The value of *status_code* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-sftpserver-struct) section for more information. # on_error event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when errors occur during data delivery. ## Syntax *Rust Syntax* ```text // SFTPServerErrorEventArgs carries the SFTPServer Error event's parameters. pub struct SFTPServerErrorEventArgs { fn connection_id(&self) -> i32 fn error_code(&self) -> i32 fn description(&self) -> &String } // SFTPServerErrorEvent defines the signature of the SFTPServer Error event's handler function. pub trait SFTPServerErrorEvent { fn on_error(&self, sender : SFTPServer, e : &mut SFTPServerErrorEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_error(&self) -> &'a dyn SFTPServerErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn SFTPServerErrorEvent); ... } ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error. *ConnectionId* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-sftpserver-struct) section. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-sftpserver-struct) section. # on_file_close event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client attempts to close an open file or directory handle. ## Syntax *Rust Syntax* ```text // SFTPServerFileCloseEventArgs carries the SFTPServer FileClose event's parameters. pub struct SFTPServerFileCloseEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn handle(&self) -> &String fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerFileCloseEvent defines the signature of the SFTPServer FileClose event's handler function. pub trait SFTPServerFileCloseEvent { fn on_file_close(&self, sender : SFTPServer, e : &mut SFTPServerFileCloseEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_file_close(&self) -> &'a dyn SFTPServerFileCloseEvent; pub fn set_on_file_close(&mut self, value : &'a dyn SFTPServerFileCloseEvent); ... } ``` ## Remarks The on_file_close event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_CLOSE request. The *Path* parameter will contain the path of the file to close. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_file_open event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to open or create a file. ## Syntax *Rust Syntax* ```text // SFTPServerFileOpenEventArgs carries the SFTPServer FileOpen event's parameters. pub struct SFTPServerFileOpenEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn desired_access(&self) -> i32 fn flags(&self) -> i32 fn file_type(&self) -> i32 fn file_size(&self) -> i64 fn file_owner(&self) -> &String fn file_group(&self) -> &String fn file_permissions(&self) -> i32 fn file_a_time(&self) -> i64 fn file_create_time(&self) -> i64 fn file_m_time(&self) -> i64 fn file_attrib_bits(&self) -> i32 fn file_attrib_bits_valid(&self) -> i32 fn other_attributes(&self) -> &String fn handle(&self) -> &String fn set_handle(&self, value : &str) fn set_handle_ref(&self, value : &String) fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerFileOpenEvent defines the signature of the SFTPServer FileOpen event's handler function. pub trait SFTPServerFileOpenEvent { fn on_file_open(&self, sender : SFTPServer, e : &mut SFTPServerFileOpenEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_file_open(&self) -> &'a dyn SFTPServerFileOpenEvent; pub fn set_on_file_open(&mut self, value : &'a dyn SFTPServerFileOpenEvent); ... } ``` ## Remarks The *Path* parameter specifies the path and name of the file to open, create. If the operation can be completed successfully, the *Handle* parameter should be set to the handle identifying the opened file. NOTE: The *Handle* parameter is limited to a 256-byte string. By default, the struct will provide an incremental numeric string value for the Handle. This event is fired both before and after the file is opened. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. The *Flags* parameter specifies file creation and locking options as a bitmask. This may be a combination of the following values: - SSH_FXF_READ (0x00000001) - SSH_FXF_WRITE (0x00000002) - SSH_FXF_APPEND (0x00000004) - SSH_FXF_CREAT (0x00000008) - SSH_FXF_TRUNC (0x00000010) - SSH_FXF_EXCL (0x00000020) The *DesiredAccess* parameter is a bitmask containing a combination of values from the ace-mask flags (only for protocol versions 4 and up). This may be a combination of the following values: - ACE4_READ_DATA (0x00000001) - ACE4_LIST_DIRECTORY (0x00000001) - ACE4_WRITE_DATA (0x00000002) - ACE4_ADD_FILE (0x00000002) - ACE4_APPEND_DATA (0x00000004) - ACE4_ADD_SUBDIRECTORY (0x00000004) - ACE4_READ_NAMED_ATTRS (0x00000008) - ACE4_WRITE_NAMED_ATTRS (0x00000010) - ACE4_EXECUTE (0x00000020) - ACE4_DELETE_CHILD (0x00000040) - ACE4_READ_ATTRIBUTES (0x00000080) - ACE4_WRITE_ATTRIBUTES (0x00000100) - ACE4_DELETE (0x00010000) - ACE4_READ_ACL (0x00020000) - ACE4_WRITE_ACL (0x00040000) - ACE4_WRITE_OWNER (0x00080000) - ACE4_SYNCHRONIZE (0x00100000) Please see RFC 3010 for more information on the semantics of these values. File/Directory Attributes are specified using the following values: *FileType*: The type of file. Can be one of the following values: - SSH_FILEXFER_TYPE_REGULAR (1) - SSH_FILEXFER_TYPE_DIRECTORY (2) - SSH_FILEXFER_TYPE_SYMLINK (3) - SSH_FILEXFER_TYPE_SPECIAL (4) - SSH_FILEXFER_TYPE_UNKNOWN (5) - SSH_FILEXFER_TYPE_SOCKET (6) - SSH_FILEXFER_TYPE_CHAR_DEVICE (7) - SSH_FILEXFER_TYPE_BLOCK_DEVICE (8) - SSH_FILEXFER_TYPE_FIFO (9) *FileSize*: The file size, in bytes. *FileOwner*: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string. *FileGroup*: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string. *FilePermissions*: The POSIX-style file permissions. *FileATime*: The file last-access time, in milliseconds since January 1, 1970, in UTC. *FileCreateTime*: The file creation time, in milliseconds since January 1, 1970, in UTC. *FileMTime*: The file last-modified time, in milliseconds since January 1, 1970, in UTC. *FileAttrBits*: The file attributes, as a combination of the following values: - SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001) - SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002) - SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004) - SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008) - SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010) - SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020) - SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040) - SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080) - SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100) - SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200) - SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400) - SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800) *FileAttrBitsValid*: A mask specifying which bits in *FileAttrBits* are supported by the server. *OtherAttributes*: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following: - MIMEType (String) - AllocationSize (64-bit int) - ATimeNS (int): ATime nanoseconds - CreateTimeNS (int): CreateTime nanoseconds - MTimeNS (int): MTime nanoseconds - TextHint (8-bit int) - LinkCount (int) - UntranslatedName (String) *FileMimeType*: The MIME type of the file. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_file_read event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to read from an open file. ## Syntax *Rust Syntax* ```text // SFTPServerFileReadEventArgs carries the SFTPServer FileRead event's parameters. pub struct SFTPServerFileReadEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn handle(&self) -> &String fn file_offset(&self) -> i64 fn length(&self) -> i32 fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerFileReadEvent defines the signature of the SFTPServer FileRead event's handler function. pub trait SFTPServerFileReadEvent { fn on_file_read(&self, sender : SFTPServer, e : &mut SFTPServerFileReadEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_file_read(&self) -> &'a dyn SFTPServerFileReadEvent; pub fn set_on_file_read(&mut self, value : &'a dyn SFTPServerFileReadEvent); ... } ``` ## Remarks The *Handle* parameter identifies an open file on the server. *FileOffset* specifies the position from which to read data. *Length* specifies how much data to read. The data read should be set to through [sftp_connection_file_data](#sftp_connection_file_data-property-sftpserver-struct) When processing a read request, the server should attempt to read at most *Length* bytes, but it is okay to read less than *Length* bytes as well, if no more data are available. When there are no more data to be read from the file, set *StatusCode* to SSH_FXS_EOF. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_file_remove event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to delete a file. ## Syntax *Rust Syntax* ```text // SFTPServerFileRemoveEventArgs carries the SFTPServer FileRemove event's parameters. pub struct SFTPServerFileRemoveEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerFileRemoveEvent defines the signature of the SFTPServer FileRemove event's handler function. pub trait SFTPServerFileRemoveEvent { fn on_file_remove(&self, sender : SFTPServer, e : &mut SFTPServerFileRemoveEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_file_remove(&self) -> &'a dyn SFTPServerFileRemoveEvent; pub fn set_on_file_remove(&mut self, value : &'a dyn SFTPServerFileRemoveEvent); ... } ``` ## Remarks The *Path* parameter will specify the file to delete. This event is fired both before and after the file is removed. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_file_rename event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to rename a file. ## Syntax *Rust Syntax* ```text // SFTPServerFileRenameEventArgs carries the SFTPServer FileRename event's parameters. pub struct SFTPServerFileRenameEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn new_path(&self) -> &String fn flags(&self) -> i32 fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerFileRenameEvent defines the signature of the SFTPServer FileRename event's handler function. pub trait SFTPServerFileRenameEvent { fn on_file_rename(&self, sender : SFTPServer, e : &mut SFTPServerFileRenameEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_file_rename(&self) -> &'a dyn SFTPServerFileRenameEvent; pub fn set_on_file_rename(&mut self, value : &'a dyn SFTPServerFileRenameEvent); ... } ``` ## Remarks The *Path* parameter will specify the file to rename and *NewPath* will specify the new name. The *Flags* parameter will be a bit mask of the values SSH_FXF_RENAME_OVERWRITE (0x00000001), SSH_FXF_RENAME_ATOMIC (0x00000002), and SSH_FXF_RENAME_NATIVE (0x00000004). This event is fired both before and after the file is renamed. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_file_write event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client wants to write to an open file. ## Syntax *Rust Syntax* ```text // SFTPServerFileWriteEventArgs carries the SFTPServer FileWrite event's parameters. pub struct SFTPServerFileWriteEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn handle(&self) -> &String fn file_offset(&self) -> i64 fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerFileWriteEvent defines the signature of the SFTPServer FileWrite event's handler function. pub trait SFTPServerFileWriteEvent { fn on_file_write(&self, sender : SFTPServer, e : &mut SFTPServerFileWriteEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_file_write(&self) -> &'a dyn SFTPServerFileWriteEvent; pub fn set_on_file_write(&mut self, value : &'a dyn SFTPServerFileWriteEvent); ... } ``` ## Remarks The *Handle* parameter identifies an open file on the server. *FileOffset* specifies the position at which to write data. The data to write can be retrieved through [sftp_connection_file_data](#sftp_connection_file_data-property-sftpserver-struct) This event is fired both before and after the file is written. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_get_attributes event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client needs to get file information. ## Syntax *Rust Syntax* ```text // SFTPServerGetAttributesEventArgs carries the SFTPServer GetAttributes event's parameters. pub struct SFTPServerGetAttributesEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn flags(&self) -> i32 fn file_type(&self) -> i32 fn set_file_type(&self, value : i32) fn file_size(&self) -> i64 fn set_file_size(&self, value : i64) fn file_owner(&self) -> &String fn set_file_owner(&self, value : &str) fn set_file_owner_ref(&self, value : &String) fn file_group(&self) -> &String fn set_file_group(&self, value : &str) fn set_file_group_ref(&self, value : &String) fn file_permissions(&self) -> i32 fn set_file_permissions(&self, value : i32) fn file_a_time(&self) -> i64 fn set_file_a_time(&self, value : i64) fn file_create_time(&self) -> i64 fn set_file_create_time(&self, value : i64) fn file_m_time(&self) -> i64 fn set_file_m_time(&self, value : i64) fn file_attrib_bits(&self) -> i32 fn set_file_attrib_bits(&self, value : i32) fn file_attrib_bits_valid(&self) -> i32 fn set_file_attrib_bits_valid(&self, value : i32) fn other_attributes(&self) -> &String fn set_other_attributes(&self, value : &str) fn set_other_attributes_ref(&self, value : &String) fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerGetAttributesEvent defines the signature of the SFTPServer GetAttributes event's handler function. pub trait SFTPServerGetAttributesEvent { fn on_get_attributes(&self, sender : SFTPServer, e : &mut SFTPServerGetAttributesEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_get_attributes(&self) -> &'a dyn SFTPServerGetAttributesEvent; pub fn set_on_get_attributes(&mut self, value : &'a dyn SFTPServerGetAttributesEvent); ... } ``` ## Remarks The on_get_attributes event fires when a secure file transfer protocol (SFTP) client sends an SSH_FXP_STAT, SSH_FXP_LSTAT, or SSH_FXP_FSTAT request. *Path* is the file path. *Flags* specifies the set of file attributes the client is interested in. File/Directory Attributes are specified using the following values: *FileType*: The type of file. Can be one of the following values: - SSH_FILEXFER_TYPE_REGULAR (1) - SSH_FILEXFER_TYPE_DIRECTORY (2) - SSH_FILEXFER_TYPE_SYMLINK (3) - SSH_FILEXFER_TYPE_SPECIAL (4) - SSH_FILEXFER_TYPE_UNKNOWN (5) - SSH_FILEXFER_TYPE_SOCKET (6) - SSH_FILEXFER_TYPE_CHAR_DEVICE (7) - SSH_FILEXFER_TYPE_BLOCK_DEVICE (8) - SSH_FILEXFER_TYPE_FIFO (9) *FileSize*: The file size, in bytes. *FileOwner*: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string. *FileGroup*: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string. *FilePermissions*: The POSIX-style file permissions. *FileATime*: The file last-access time, in milliseconds since January 1, 1970, in UTC. *FileCreateTime*: The file creation time, in milliseconds since January 1, 1970, in UTC. *FileMTime*: The file last-modified time, in milliseconds since January 1, 1970, in UTC. *FileAttrBits*: The file attributes, as a combination of the following values: - SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001) - SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002) - SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004) - SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008) - SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010) - SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020) - SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040) - SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080) - SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100) - SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200) - SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400) - SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800) *FileAttrBitsValid*: A mask specifying which bits in *FileAttrBits* are supported by the server. *OtherAttributes*: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following: - MIMEType (String) - AllocationSize (64-bit int) - ATimeNS (int): ATime nanoseconds - CreateTimeNS (int): CreateTime nanoseconds - MTimeNS (int): MTime nanoseconds - TextHint (8-bit int) - LinkCount (int) - UntranslatedName (String) *FileMimeType*: The MIME type of the file. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_log event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired once for each log message. ## Syntax *Rust Syntax* ```text // SFTPServerLogEventArgs carries the SFTPServer Log event's parameters. pub struct SFTPServerLogEventArgs { fn connection_id(&self) -> i32 fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // SFTPServerLogEvent defines the signature of the SFTPServer Log event's handler function. pub trait SFTPServerLogEvent { fn on_log(&self, sender : SFTPServer, e : &mut SFTPServerLogEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_log(&self) -> &'a dyn SFTPServerLogEvent; pub fn set_on_log(&mut self, value : &'a dyn SFTPServerLogEvent); ... } ``` ## 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. *ConnectionId* identifies the connection to which the log message applies. # on_resolve_path event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client attempts to canonicalize a path. ## Syntax *Rust Syntax* ```text // SFTPServerResolvePathEventArgs carries the SFTPServer ResolvePath event's parameters. pub struct SFTPServerResolvePathEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn original_path(&self) -> &String fn control_flags(&self) -> i32 fn real_path(&self) -> &String fn set_real_path(&self, value : &str) fn set_real_path_ref(&self, value : &String) fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerResolvePathEvent defines the signature of the SFTPServer ResolvePath event's handler function. pub trait SFTPServerResolvePathEvent { fn on_resolve_path(&self, sender : SFTPServer, e : &mut SFTPServerResolvePathEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_resolve_path(&self) -> &'a dyn SFTPServerResolvePathEvent; pub fn set_on_resolve_path(&mut self, value : &'a dyn SFTPServerResolvePathEvent); ... } ``` ## Remarks The on_resolve_path event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_REALPATH request. The *OriginalPath* parameter will contain the path the client wants to canonicalize. *ControlFlags* can have one of the following values: | | | | --- | --- | | SSH_FXP_REALPATH_NO_CHECK (0x00000001) | Server should not check if the path exists. | | SSH_FXP_REALPATH_STAT_IF (0x00000002) | Server should return the file/directory attributes if the path exists and is accessible, but otherwise should not fail. | | SSH_FXP_REALPATH_STAT_ALWAYS (0x00000003) | Server should return the file/directory attributes if the path exists and is accessible, but otherwise will fail with an error. | *RealPath* should be set to the resulting canonicalized path, and *StatusCode* should be set to indicate the success or failure of the operation to the client. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_set_attributes event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client attempts to set file or directory attributes. ## Syntax *Rust Syntax* ```text // SFTPServerSetAttributesEventArgs carries the SFTPServer SetAttributes event's parameters. pub struct SFTPServerSetAttributesEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn path(&self) -> &String fn file_type(&self) -> i32 fn file_size(&self) -> i64 fn file_owner(&self) -> &String fn file_group(&self) -> &String fn file_permissions(&self) -> i32 fn file_a_time(&self) -> i64 fn file_create_time(&self) -> i64 fn file_m_time(&self) -> i64 fn file_attrib_bits(&self) -> i32 fn file_attrib_bits_valid(&self) -> i32 fn other_attributes(&self) -> &String fn before_exec(&self) -> bool fn status_code(&self) -> i32 fn set_status_code(&self, value : i32) } // SFTPServerSetAttributesEvent defines the signature of the SFTPServer SetAttributes event's handler function. pub trait SFTPServerSetAttributesEvent { fn on_set_attributes(&self, sender : SFTPServer, e : &mut SFTPServerSetAttributesEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_set_attributes(&self) -> &'a dyn SFTPServerSetAttributesEvent; pub fn set_on_set_attributes(&mut self, value : &'a dyn SFTPServerSetAttributesEvent); ... } ``` ## Remarks The on_set_attributes event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_SETSTAT, SSH_FXP_FSETSTAT, or SSH_FXP_FSTAT request. *Path* is the path of the file or directory the client wants to set attributes for. This event is fired both before and after the attributes are set. The *BeforeExec* parameter is *True* before the operation has been executed and *False* otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation. File/Directory Attributes are specified using the following values: *FileType*: The type of file. Can be one of the following values: - SSH_FILEXFER_TYPE_REGULAR (1) - SSH_FILEXFER_TYPE_DIRECTORY (2) - SSH_FILEXFER_TYPE_SYMLINK (3) - SSH_FILEXFER_TYPE_SPECIAL (4) - SSH_FILEXFER_TYPE_UNKNOWN (5) - SSH_FILEXFER_TYPE_SOCKET (6) - SSH_FILEXFER_TYPE_CHAR_DEVICE (7) - SSH_FILEXFER_TYPE_BLOCK_DEVICE (8) - SSH_FILEXFER_TYPE_FIFO (9) *FileSize*: The file size, in bytes. *FileOwner*: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string. *FileGroup*: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string. *FilePermissions*: The POSIX-style file permissions. *FileATime*: The file last-access time, in milliseconds since January 1, 1970, in UTC. *FileCreateTime*: The file creation time, in milliseconds since January 1, 1970, in UTC. *FileMTime*: The file last-modified time, in milliseconds since January 1, 1970, in UTC. *FileAttrBits*: The file attributes, as a combination of the following values: - SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001) - SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002) - SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004) - SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008) - SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010) - SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020) - SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040) - SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080) - SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100) - SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200) - SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400) - SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800) *FileAttrBitsValid*: A mask specifying which bits in *FileAttrBits* are supported by the server. *OtherAttributes*: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following: - MIMEType (String) - AllocationSize (64-bit int) - ATimeNS (int): ATime nanoseconds - CreateTimeNS (int): CreateTime nanoseconds - MTimeNS (int): MTime nanoseconds - TextHint (8-bit int) - LinkCount (int) - UntranslatedName (String) *FileMimeType*: The MIME type of the file. Valid status codes are as follows: - SSH_FX_OK 0 - SSH_FX_EOF 1 - SSH_FX_NO_SUCH_FILE 2 - SSH_FX_PERMISSION_DENIED 3 - SSH_FX_FAILURE 4 - SSH_FX_BAD_MESSAGE 5 - SSH_FX_NO_CONNECTION 6 - SSH_FX_CONNECTION_LOST 7 - SSH_FX_OP_UNSUPPORTED 8 - SSH_FX_INVALID_HANDLE 9 - SSH_FX_NO_SUCH_PATH 10 - SSH_FX_FILE_ALREADY_EXISTS 11 - SSH_FX_WRITE_PROTECT 12 - SSH_FX_NO_MEDIA 13 - SSH_FX_NO_SPACE_ON_FILESYSTEM 14 - SSH_FX_QUOTA_EXCEEDED 15 - SSH_FX_UNKNOWN_PRINCIPAL 16 - SSH_FX_LOCK_CONFLICT 17 - SSH_FX_DIR_NOT_EMPTY 18 - SSH_FX_NOT_A_DIRECTORY 19 - SSH_FX_INVALID_FILENAME 20 - SSH_FX_LINK_LOOP 21 - SSH_FX_CANNOT_DELETE 22 - SSH_FX_INVALID_PARAMETER 23 - SSH_FX_FILE_IS_A_DIRECTORY 24 - SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25 - SSH_FX_BYTE_RANGE_LOCK_REFUSED 26 - SSH_FX_DELETE_PENDING 27 - SSH_FX_FILE_CORRUPT 28 - SSH_FX_OWNER_INVALID 29 - SSH_FX_GROUP_INVALID 30 - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31 # on_ssh_status event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired to track the progress of the secure connection. ## Syntax *Rust Syntax* ```text // SFTPServerSSHStatusEventArgs carries the SFTPServer SSHStatus event's parameters. pub struct SFTPServerSSHStatusEventArgs { fn connection_id(&self) -> i32 fn message(&self) -> &String } // SFTPServerSSHStatusEvent defines the signature of the SFTPServer SSHStatus event's handler function. pub trait SFTPServerSSHStatusEvent { fn on_ssh_status(&self, sender : SFTPServer, e : &mut SFTPServerSSHStatusEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_ssh_status(&self) -> &'a dyn SFTPServerSSHStatusEvent; pub fn set_on_ssh_status(&mut self, value : &'a dyn SFTPServerSSHStatusEvent); ... } ``` ## Remarks This event is fired for informational and logging purposes only and is used to track the progress of the connection. # on_ssh_user_auth_request event ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) Fired when a client attempts to authenticate a connection. ## Syntax *Rust Syntax* ```text // SFTPServerSSHUserAuthRequestEventArgs carries the SFTPServer SSHUserAuthRequest event's parameters. pub struct SFTPServerSSHUserAuthRequestEventArgs { fn connection_id(&self) -> i32 fn user(&self) -> &String fn service(&self) -> &String fn auth_method(&self) -> &String fn auth_param(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) fn partial_success(&self) -> bool fn set_partial_success(&self, value : bool) fn available_methods(&self) -> &String fn set_available_methods(&self, value : &str) fn set_available_methods_ref(&self, value : &String) fn home_dir(&self) -> &String fn set_home_dir(&self, value : &str) fn set_home_dir_ref(&self, value : &String) fn key_algorithm(&self) -> &String } // SFTPServerSSHUserAuthRequestEvent defines the signature of the SFTPServer SSHUserAuthRequest event's handler function. pub trait SFTPServerSSHUserAuthRequestEvent { fn on_ssh_user_auth_request(&self, sender : SFTPServer, e : &mut SFTPServerSSHUserAuthRequestEventArgs); } impl <'a> SFTPServer<'a> { pub fn on_ssh_user_auth_request(&self) -> &'a dyn SFTPServerSSHUserAuthRequestEvent; pub fn set_on_ssh_user_auth_request(&mut self, value : &'a dyn SFTPServerSSHUserAuthRequestEvent); ... } ``` ## Remarks The on_ssh_user_auth_request event fires when a Secure Shell (SSH) client attempts to authenticate itself on a particular connection. *ConnectionId* will identify the connection being authenticated. *User* will be the name of the account requesting authentication, and *Service* will contain the name of the service the client is wishing to access. *AuthMethod* will denote which method the client is attempting to use to authenticate itself. *AuthParam* will contain the value of the authentication token used by the client. If the token is acceptable, you may set *Accept* to True to allow the SFTPServer to authenticate the client. If it is not, set *Accept* to False. Connecting clients will initially attempt authentication with an *AuthMethod* of "none". This is done with the expectation that the request will fail and the server will send a list of supported methods back to the client. In your implementation, check the *AuthMethod* parameter; if it is "none", you should set *AvailableMethods* and reject the request. The client will select one of the available methods and reauthenticate. You may set *AvailableMethods* to a comma-delimited string of authentication methods that are available for the user. This list will be sent back to the client so that it may perform further authentication attempts. The following is a list of methods implemented by the struct: | | | | --- | --- | | none | This authentication method is used by most Secure Shell (SSH) clients to obtain the list of authentication methods available for the user's account. In most cases, you should not accept a request using this authentication method. | | password | AuthParam will contain the user-supplied password. If the password is correct, set Accept to True. | | publickey | AuthParam will contain an SSH2 public key blob. If the user's public key is acceptable, set Accept or PartialSuccess to true. The struct will then handle verifying the digital signature and will respond to the client accordingly. | | keyboard-interactive | on_ssh_user_auth_request will fire multiple times for keyboard-interactive authentication: It will fire once for each response sent by the client in the SSH_MSG_USERAUTH_INFO_RESPONSE packet (one time for each prompt specified by the daemon). The index of each response will be specified as a suffix in AuthMethod, with AuthParam containing the response to the corresponding prompt (e.g., keyboard-interactive-1, keyboard-interactive-2, and so on). Finally, on_ssh_user_auth_request will fire one last time with AuthMethod set to "keyboard-interactive" and AuthParam set to an empty string. The daemon must set Accept to True every time to allow the authentication process to succeed. | If the user authentication succeeds, you may set *HomeDir* to the virtual path representing the initial directory for the user. If not set, the initial directory will be [root_directory](#root_directory-property-sftpserver-struct). The *PartialSuccess* parameter is used only when multifactor authentication is needed. To implement multifactor authentication when this event fires, first verify the *AuthParam* for the given *AuthMethod*. If accepted, set *PartialSuccess* to True and *Accept* to False. The client should then send the authentication request for a different form of authentication specified in *AvailableMethods*. You may continue to set *PartialSuccess* to True until all authentication requirements are satisfied. Once all requirements are satisfied set *Accept* to True. *KeyAlgorithm* holds the signing algorithm used when the client attempts public key authentication. Possible values are as follows: - ssh-rsa - rsa-sha2-256 - rsa-sha2-512 - ssh-dss - ecdsa-sha2-nistp256 - ecdsa-sha2-nistp384 - ecdsa-sha2-nistp521 - x509v3-sign-rsa - x509v3-sign-dss NOTE: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event. # Config Settings ([SFTPServer](#struct-ipworkssftpsftpserver) 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-sftpserver-struct) method. ### SFTPServer Config Settings **DirListBufferSize[ConnectionId]**: The number of entries to be returned in one response to a request for a directory listing.The default value for this configuration setting is 1, which means that the struct will return one entry at a time in response to a request for a directory listing. Changing this value will allow the struct to bundle multiple entries into a single response. **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. **MaxStartupsConnections**: The number of unauthenticated connections that the server will accept. This configuration setting specifies the number of unauthenticated connections the server will accept before rejecting new connection attempts. The default value is 50. Additionally, unauthenticated connections may only request a buffer of 256 KB and will be disconnected if they are not authenticated within 120 seconds. **ProtocolVersion**: The highest allowable SFTP version to use.This configuration setting governs the highest allowable secure file transfer protocol (SFTP) version to use when negotiating the version with the client. The default value is 3 because this is the most common version. The struct supports values from 3 to 6. **RestrictUserToHomeDir[ConnectionId]**: Whether to restrict the user to their home directory.When True, this configuration setting will restrict the user to the path specified by the "HomeDir" parameter in the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event. When False (default), the user will be able to navigate outside of the home directory. "ConnectionId" specifies the connection to which the restriction applies. ```text sftpserver.Config("RestrictUserToHomeDir[" + e.ConnectionId + "]=true"); ``` ## Example If the [root_directory](#root_directory-property-sftpserver-struct) property of a certain SFTP server is set to */*, then the directory structure of the server might look like this: ```text Root Directory: / bin boot etc home user1 testfolder ``` When RestrictUserToHomeDir is set to True and the "HomeDir" parameter is set to */home/user1*, User 1 will land in the home directory and see the following file system when it connects: ```text Home Directory: /home/user1 /testfolder ``` The client will be able to perform operations only against */home/user1* and its children, but the client can see its working directory relative to the server root directory. **ServerEOL**: Specifies the line endings used in files on the server.This configuration setting is used to inform the connecting client what line endings are used in the files on the system. This is applicable only when [ProtocolVersion](#ProtocolVersion) is set to 4 or higher and a connecting client negotiates protocol version 4 or higher. When a client negotiates version 4 or higher, this value is reported using the "newline" protocol convention. The client may use that to transform line endings when downloading. The default value is CrLF. **SFTPErrorMessage[ConnectionId]**: Specifies the error message to be returned to the client.If an SFTP operation would return an error to the client (e.g., permission denied, file does not exist), then this configuration setting can be used to specify the error message to be returned to the client. This optional configuration setting is effective only when set within an event that uses the "StatusCode" field. **UnixStyleDateFormat**: Controls whether to use the Unix-style date format in directory listings.When set to True, the struct will report entries in the Unix-style date format: if the modification time is within the previous 180 days, the date will be formatted as "Mmm dd hh:mm"; otherwise, it will be formatted as "Mmm dd yyyy". **UserRootDirectory[ConnectionId]**: The path of the server root directory for a particular user.When set to a subdirectory of the server root, this configuration setting will override the server [root_directory](#root_directory-property-sftpserver-struct) for a particular user. The "HomeDir" parameter of the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event will represent the initial path of the client relative to the UserRootDirectory. "ConnectionId" specifies the connection to which the restriction applies. ```text sftpserver.Config("UserRootDirectory[" + e.ConnectionId + "]=" + userRootDirectory ); ``` ## Example If the [root_directory](#root_directory-property-sftpserver-struct) property of a certain SFTP server is set to */*, then the directory structure of the server might look like this: ```text Root Directory: / bin boot etc home user1 testfolder ``` When UserRootDirectory is set to */home/user1* and the HomeDir event parameter is set to */*, when User 1 connects they will land in the home directory and see the following file system: ```text Home Directory: / /testfolder ``` The client will be able to perform operations only against */* and its children, and the client cannot see its working directory relative to the server root directory. ### SSHServer Config Settings **AltSSHCertCount**: The number of records in the AltSSHCert configuration settings.This configuration setting controls the size of the following arrays: - [AltSSHCertStore](#AltSSHCertStore) - [AltSSHCertStorePassword](#AltSSHCertStorePassword) - [AltSSHCertStoreType](#AltSSHCertStoreType) - [AltSSHCertSubject](#AltSSHCertSubject) The array indices start at *0* and end at *AltSSHCertCount - 1*. The AltSSHCert configuration settings are used to specify alternative digital certificates to the one set using the ssh_cert. The server will determine the certificate to use during Secure Shell (SSH) negotiation based on the public key algorithm requested by the connecting client. A certificate with a private key is required for session authentication and encryption. The [AltSSHCertSubject](#AltSSHCertSubject) setting must be set last. When [AltSSHCertSubject](#AltSSHCertSubject) is set, a search is initiated in the [AltSSHCertStore](#AltSSHCertStore) and the certificate is loaded. The alternative server certificate specified by these settings must be configured before setting [listening](#listening-property-sftpserver-struct) to *true*. For example: ```csharp sftpserver.Config("AltSSHCertCount =1"); sftpserver.Config("AltSSHCertStoreType[0]=7"); //PEM Key Blob sftpserver.Config("AltSSHCertStore[0]=" + ed25519Key); //PEM formatted string sftpserver.Config("AltSSHCertSubject[0]=*"); //Load the first (and only) certificate ``` **AltSSHCertStore[i]**: The name of the certificate store.The name of the certificate store. This configuration setting is used when specifying an alternative ssh_cert. The [AltSSHCertStoreType](#AltSSHCertStoreType) specifies the type of the certificate store specified by [AltSSHCertStore](#AltSSHCertStore). If the store is password protected, specify the password in the [AltSSHCertStorePassword](#AltSSHCertStorePassword). [AltSSHCertStore](#AltSSHCertStore) is used in conjunction with the [AltSSHCertSubject](#AltSSHCertSubject) field to specify the certificate. 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). **AltSSHCertStorePassword[i]**: The password used to open the certificate store.If the certificate store requires a password, this configuration setting can be used to specify that password. This setting is used when specifying an alternative ssh_cert **AltSSHCertStoreType[i]**: The type of certificate store.This configuration setting specifies the type of certificate store. This setting is used when specifying an alternate ssh_cert. Possible values are as follows: | | | | --- | --- | | 0 | User - This is the 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 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - 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 available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | **AltSSHCertSubject[i]**: The alternative certificate subject.The subject of the certificate. This configuration setting is used when specifying an alternative ssh_cert. The special value of *** may be used to select the first certificate in the store. **ClientSSHVersionString[ConnectionId]**: The client's version string.This configuration setting returns a connected client's SSH version string. It may be queried inside [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct). ```csharp sftpserver1.OnSSHUserAuthRequest += (obj, ev) => { Console.WriteLine(sftpserver1.Config("ClientSSHVersionString[" + ev.ConnectionId + "]")); }; ``` **FireAuthRequestAfterSig**: Whether to fire an informational event after the public key signature has been verified.When performing public key authentication, the connecting client will present both the public key as well as a signature to verify ownership of the corresponding private key. The struct will automatically verify the signature and respond to the client to indicate whether the signature could be verified and the connection can continue. This configuration setting controls whether an additional informational event fires to report the result of the signature verification. If set to *true*, the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event will fire twice per public key authentication attempt. The first time the event fires for public key authentication as usual. After verification of the signature has taken place, the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) will fire again, and the *AuthMethod* parameter will contain the string *sigstatus*. The *AuthParam* parameter will contain a value of *0* (invalid signature) or *1* (valid signature). If the signature is invalid, it will always result in a rejected authentication attempt. **KeyboardInteractivePrompts[ConnectionId]**: Specifies custom keyboard-interactive prompts for particular connections.By default, setting the keyboard_interactive_prompts property will cause those prompts to be used for every user attempting to connect. This setting can be used to override the keyboard_interactive_prompts property and provide unique prompts for certain connections. This configuration setting takes a list of prompts to display to the client, and each prompt includes an 'echo' parameter to specify whether or not to echo the client's response to the prompt. The prompt and the echo parameter should be separated by a comma (","), and each prompt should be separated by a semicolon (";"). For example: "KeyboardInteractivePrompts[connId]=First prompt,echo=false;Second prompt,echo=true" This configuration setting can be set anywhere in code, but it is necessary to know the ConnectionId for the specific connection beforehand; as such, it is generally recommended to set this configuration inside the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event. Because connecting clients initially attempt to connect with and *AuthMethod* of 'none' (with the understanding that this attempt will fail, and the SSH server will advertise which authentication methods it supports), it is recommended to check the *AuthMethod*, *User*, and *ConnectionId* parameters of the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event and set this configuration setting accordingly. When SSHServer displays keyboard-interactive prompts, it will first check to see if this configuration setting is populated for the current ConnectionId. If it is, the prompts set here will be used instead of those set in the keyboard_interactive_prompts property. Otherwise, the keyboard_interactive_prompts property will function as normal. **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-sftpserver-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. | **MaxAuthAttempts**: The maximum authentication attempts allowed before forcing a disconnect.This configuration setting specifies the maximum amount of authentication attempts that will be allowed before forcibly disconnecting the client. **NegotiatedStrictKex[ConnectionId]**: Returns whether strict key exchange was negotiated to be used.Returns whether strict key exchange (strict kex) was negotiated during the SSH handshake. This is a per-connection configuration setting accessed by passing the ConnectionId. 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[connId]") ``` **ServerSSHVersionString**: The SSH version string sent to connecting clients.This configuration setting specifies the version string value that is sent to all connecting clients. This may be set to specify server specific information. The default value is "SSH-2.0-IPWorks SSH Daemon 2024". When setting your own value, it must begin with "SSH-2.0-" because this is a standard format that specifies the supported SSH version. **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*. **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 allowed signature algorithms used by a client performing public key authentication.This configuration setting specifies a list of signature algorithms that a client is allowed to use when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client. The configuration setting should be a comma-separated list of algorithms. When a client connects, the server will verify that the client performing the public key authentication has used one of the specified signature algorithms. If the client uses a signature algorithm that is not in the list, the connection will be rejected. Possible values areas 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,x509v3-sign-rsa,ssh-dss,x509v3-sign-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519*. **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-* ``` **UserAuthBanner[ConnectionId]**: A custom user authentication banner.This configuration setting specifies a custom user authentication banner, which may be sent to give the client more information regarding an authentication attempt. "ConnectionId" specifies the particular connection to send the message to. This configuration option is effective only when set within the [on_ssh_user_auth_request](#on_ssh_user_auth_request-event-sftpserver-struct) event. **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. | ### TCPServer Config Settings **AllowedClients**: A comma-separated list of host names or IP addresses that can access the struct.This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the struct. The wildcard character "*" is supported. The default value is "*" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is no match, the [on_connection_request](#on_connection_request-event-sftpserver-struct) event fires with an *Accept* value set to *false*. If no action is taken within the [on_connection_request](#on_connection_request-event-sftpserver-struct) event, the client will be disconnected. **BindExclusively**: Whether or not the component considers a local port reserved for exclusive use.If this is *true* (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure. **BlockedClients**: A comma-separated list of host names or IP addresses that cannot access the struct.This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the struct.The default value is "" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is a match, the [on_connection_request](#on_connection_request-event-sftpserver-struct) event fires with an *Accept* value set to *false*. If no action is taken within the [on_connection_request](#on_connection_request-event-sftpserver-struct) event, the client will not be connected. **DefaultConnectionTimeout**: The inactivity timeout applied to the SSL handshake.This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied. NOTE: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so. **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. Increasing the value of the [InBufferSize](#InBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated, the [InBufferSize](#InBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [InBufferSize](#InBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.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 setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections. **MaxConnections**: The maximum number of connections available. This is the maximum number of connections available. This setting must be set before [listening](#listening-property-sftpserver-struct) is set to *true*, and once set, it can no longer be changed for the current instance of the struct. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000. NOTE: Unix/Linux operating systems limit the number of simultaneous connections to 1024. **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. Increasing the value of the [OutBufferSize](#OutBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the [OutBufferSize](#OutBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [OutBufferSize](#OutBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **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. When set to 2, the struct will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 Only | | 1 | IPv6 Only | | 2 | IPv6 and IPv4 | ### 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 ([SFTPServer](#struct-ipworkssftpsftpserver) Struct) ### SFTPServer Errors | | | | --- | --- | | 118 | Firewall error. Error description contains detailed information. | | 2001 | The specified path is invalid. | | 2002 | An I/O error occurred. | | 2003 | The file attributes could not be set. | The class may also return one of the following error codes, which are inherited from other classes. ### SSHServer Errors | | | | --- | --- | | 1201 | Could not forward connection. A detailed message follows. | | 1202 | Could not forward connection/channel data. A detailed message follows. | | 1300 | Could not authenticate client. | | 1301 | No server certificate was specified or no private key found. | ### TCPServer Errors | | | | --- | --- | | 100 | You cannot change the remote_port at this time. A connection is in progress. | | 101 | You cannot change the remote_host at this time. A connection is in progress. | | 102 | The remote_host address is invalid (0.0.0.0). | | 104 | TCPServer is already listening. | | 106 | Cannot change [local_port](#local_port-property-sftpserver-struct) when TCPServer is listening. | | 107 | Cannot change [local_host](#local_host-property-sftpserver-struct) when TCPServer is listening. | | 108 | Cannot change [MaxConnections](#MaxConnections) when TCPServer is listening. | | 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. | | 126 | Invalid ConnectionId. | | 135 | Operation would block. | ### 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). |