# SFTPClient Class The SFTPClient class provides client-side functionality for SFTP (Secure File Transfer Protocol). ## Syntax ```text class secureblackbox.SFTPClient ``` ## Remarks SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities. Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers. Below are the typical steps that let you integrate SFTPClient to your project: - Set up your [username](#username-property) and [password](#password-property). SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use key property to provide your key, if needed. - Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the [trusted_keys_file](#trusted_keys_file-property) property. When a client receives a server key, it reports it to your code via its [on_known_key_received](#on_known_key_received-event) or [on_unknown_key_received](#on_unknown_key_received-event) event, depending on whether the key was found in the trusted list. If you leave [trusted_keys_file](#trusted_keys_file-property) empty, SFTPClient will only be able to fire the [on_unknown_key_received](#on_unknown_key_received-event) event, since there will be no known keys to report. - If needed, customize proxy parameters and ssh_settings. - Consider interacting more with SFTPClient by subscribing to [on_auth_attempt](#on_auth_attempt-event), [on_auth_failed](#on_auth_failed-event), and [on_auth_succeeded](#on_auth_succeeded-event) events to be notified about the client authentication progress. - When you are ready to connect, call [connect](#connect-method), passing the details of the server as parameters. During the initial handshake, the following events will fire: [on_unknown_key_received](#on_unknown_key_received-event) (or [on_known_key_received](#on_known_key_received-event)), and then one or more [on_auth_attempt](#on_auth_attempt-event), [on_auth_failed](#on_auth_failed-event) and [on_auth_succeeded](#on_auth_succeeded-event). - Upon completion of the [connect](#connect-method) method, the component is ready for file operations. Use [download_file](#download_file-method), [upload_file](#upload_file-method), [list_dir](#list_dir-method), [delete_file](#delete_file-method) and other file transfer methods to work with the server file system. - When you are done with your work, call [disconnect](#disconnect-method) to close the connection. Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties: - [auto_adjust_transfer_block](#auto_adjust_transfer_block-property) to false, - [pipeline_length](#pipeline_length-property) to 1, - [upload_block_size](#upload_block_size-property) to 16384, - [download_block_size](#download_block_size-property) to 16384. These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [auth_attempts](#auth_attempts-property) | Specifies the number of SSH authentication attempts. | | [auto_adjust_transfer_block](#auto_adjust_transfer_block-property) | Specifies whether to adjust the send and receive buffer sizes automatically. | | [conflict_resolution_mode](#conflict_resolution_mode-property) | Defines the approach that should be used to resolve various conflicts during batch processing. | | [connected](#connected-property) | Indicates if the client is connected to the SFTP server. | | [conn_info_client_key_algorithm](#conn_info_client_key_algorithm-property) | Specifies the client's key algorithm. | | [conn_info_client_key_bits](#conn_info_client_key_bits-property) | Specifies the length of the client's key. | | [conn_info_client_key_fingerprint](#conn_info_client_key_fingerprint-property) | The fingerprint (hash value) of the client's public key. | | [conn_info_close_reason](#conn_info_close_reason-property) | Contains the line sent by the server just before closing the connection. | | [conn_info_compression_algorithm_inbound](#conn_info_compression_algorithm_inbound-property) | Compression algorithm for the incoming traffic. | | [conn_info_compression_algorithm_outbound](#conn_info_compression_algorithm_outbound-property) | Compression algorithm for the outgoing traffic. | | [conn_info_encryption_algorithm_inbound](#conn_info_encryption_algorithm_inbound-property) | Encryption algorithm for the incoming traffic. | | [conn_info_encryption_algorithm_outbound](#conn_info_encryption_algorithm_outbound-property) | Encryption algorithm for the outgoing traffic. | | [conn_info_inbound_encryption_key_bits](#conn_info_inbound_encryption_key_bits-property) | Specifies the length of the key used to encrypt the incoming traffic. | | [conn_info_kex_algorithm](#conn_info_kex_algorithm-property) | The key exchange algorithm used during the SSH handshake. | | [conn_info_kex_bits](#conn_info_kex_bits-property) | The number of bits used by the key exchange algorithm. | | [conn_info_kex_lines](#conn_info_kex_lines-property) | The contents of the received KexInit packet. | | [conn_info_mac_algorithm_inbound](#conn_info_mac_algorithm_inbound-property) | MAC algorithm used for the incoming connection. | | [conn_info_mac_algorithm_outbound](#conn_info_mac_algorithm_outbound-property) | MAC algorithm used for outbound connection. | | [conn_info_outbound_encryption_key_bits](#conn_info_outbound_encryption_key_bits-property) | Specifies the length of the key used to encrypt the outgoing traffic. | | [conn_info_public_key_algorithm](#conn_info_public_key_algorithm-property) | Specifies the public key algorithm which was used during the SSH handshake. | | [conn_info_remote_address](#conn_info_remote_address-property) | The client's IP address. | | [conn_info_remote_port](#conn_info_remote_port-property) | The remote port of the client connection. | | [conn_info_remote_software_name](#conn_info_remote_software_name-property) | Returns the name (self-advertised) of the SSH software running on the other side. | | [conn_info_server_key_algorithm](#conn_info_server_key_algorithm-property) | Specifies the server's key algorithm. | | [conn_info_server_key_bits](#conn_info_server_key_bits-property) | Specifies the number of bits in the server's key. | | [conn_info_server_key_fingerprint](#conn_info_server_key_fingerprint-property) | The fingerprint (hash value) of the server's public key. | | [conn_info_total_bytes_received](#conn_info_total_bytes_received-property) | Returns the total number of bytes received over this connection. | | [conn_info_total_bytes_sent](#conn_info_total_bytes_sent-property) | Returns the total number of bytes sent over this connection. | | [conn_info_version](#conn_info_version-property) | Specifies SSH protocol version. | | [curr_list_entry_access_time](#curr_list_entry_access_time-property) | Contains the last access time for this file, in UTC. | | [curr_list_entry_creation_time](#curr_list_entry_creation_time-property) | Contains this file's creation time, in UTC. | | [curr_list_entry_entry_format](#curr_list_entry_entry_format-property) | The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 . | | [curr_list_entry_file_type](#curr_list_entry_file_type-property) | The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 . | | [curr_list_entry_handle](#curr_list_entry_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [curr_list_entry_modification_time](#curr_list_entry_modification_time-property) | File last modification date/time. | | [curr_list_entry_name](#curr_list_entry_name-property) | The file or directory name. | | [curr_list_entry_path](#curr_list_entry_path-property) | The full path to the file or directory. | | [curr_list_entry_principal](#curr_list_entry_principal-property) | Specifies the owner of the file/directory. | | [curr_list_entry_size](#curr_list_entry_size-property) | File size in bytes. | | [curr_list_entry_unix_perms](#curr_list_entry_unix_perms-property) | The file Unix permissions bit mask (e. | | [curr_list_entry_unparsed_name](#curr_list_entry_unparsed_name-property) | The unparsed entry as returned by the server. | | [download_block_size](#download_block_size-property) | The download block size in bytes. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property) | Reserved. | | [force_compression](#force_compression-property) | Enforces compression for the SSH layer. | | [key_fingerprint_sha1](#key_fingerprint_sha1-property) | Contains the SHA-1 fingerprint (hash) of the key. | | [key_fingerprint_sha256](#key_fingerprint_sha256-property) | Contains the SHA-256 fingerprint (hash) of the key. | | [key_handle](#key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [max_sftp_version](#max_sftp_version-property) | Higher SFTP version to support. | | [min_sftp_version](#min_sftp_version-property) | Lower SFTP version to support. | | [password](#password-property) | Specifies user's authentication password. | | [pipeline_length](#pipeline_length-property) | The number of parallelized transfer requests. | | [proxy_address](#proxy_address-property) | The IP address of the proxy server. | | [proxy_authentication](#proxy_authentication-property) | The authentication type used by the proxy server. | | [proxy_password](#proxy_password-property) | The password to authenticate to the proxy server. | | [proxy_port](#proxy_port-property) | The port on the proxy server to connect to. | | [proxy_type](#proxy_type-property) | The type of the proxy server. | | [proxy_request_headers](#proxy_request_headers-property) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [proxy_response_body](#proxy_response_body-property) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [proxy_response_headers](#proxy_response_headers-property) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [proxy_use_ipv6](#proxy_use_ipv6-property) | Specifies whether IPv6 should be used when connecting through the proxy. | | [proxy_username](#proxy_username-property) | Specifies the username credential for proxy authentication. | | [server_key_algorithm](#server_key_algorithm-property) | Specifies the key algorithm. | | [server_key_bits](#server_key_bits-property) | The number of bits in the key: the more the better, 2048 or 4096 are typical values. | | [server_key_comment](#server_key_comment-property) | The comment for the public key. | | [server_key_curve](#server_key_curve-property) | Specifies the elliptical curve when EC cryptography is used. | | [server_key_extractable](#server_key_extractable-property) | Whether the key is extractable (e. | | [server_key_fingerprint_md5](#server_key_fingerprint_md5-property) | Contains the MD5 fingerprint (hash) of the key. | | [server_key_fingerprint_sha1](#server_key_fingerprint_sha1-property) | Contains the SHA-1 fingerprint (hash) of the key. | | [server_key_fingerprint_sha256](#server_key_fingerprint_sha256-property) | Contains the SHA-256 fingerprint (hash) of the key. | | [server_key_handle](#server_key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [server_key_key_format](#server_key_key_format-property) | Specifies the format in which the key is stored. | | [server_key_key_protection_algorithm](#server_key_key_protection_algorithm-property) | Specifies the key protection algorithm. | | [server_key_private](#server_key_private-property) | Whether this key is a private key or not. | | [server_key_public](#server_key_public-property) | Whether this key is a public key or not. | | [server_key_subject](#server_key_subject-property) | Specifies the public key owner (subject). | | [socket_dns_mode](#socket_dns_mode-property) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. | | [socket_dns_port](#socket_dns_port-property) | Specifies the port number to be used for sending queries to the DNS server. | | [socket_dns_query_timeout](#socket_dns_query_timeout-property) | The timeout (in milliseconds) for each DNS query. | | [socket_dns_servers](#socket_dns_servers-property) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [socket_dns_total_timeout](#socket_dns_total_timeout-property) | The timeout (in milliseconds) for the whole resolution process. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property) | Enables or disables IP protocol version 6. | | [ssh_settings_auto_adjust_ciphers](#ssh_settings_auto_adjust_ciphers-property) | Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. | | [ssh_settings_base_configuration](#ssh_settings_base_configuration-property) | Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. | | [ssh_settings_compression_algorithms](#ssh_settings_compression_algorithms-property) | A list of session compression algorithms separated with commas or semicolons. | | [ssh_settings_compression_level](#ssh_settings_compression_level-property) | Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). | | [ssh_settings_default_window_size](#ssh_settings_default_window_size-property) | The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server. | | [ssh_settings_encryption_algorithms](#ssh_settings_encryption_algorithms-property) | A list of session encryption algorithms separated with commas or semicolons. | | [ssh_settings_force_compression](#ssh_settings_force_compression-property) | Whether the SSH client should explicitly request compression. | | [ssh_settings_forward_auth_agent](#ssh_settings_forward_auth_agent-property) | Enables or disables auth agent forwarding. | | [ssh_settings_gss_auth_types](#ssh_settings_gss_auth_types-property) | A comma-separated list of authentication types. | | [ssh_settings_gss_delegate_creds](#ssh_settings_gss_delegate_creds-property) | Switches credential delegation on or off. | | [ssh_settings_gss_hostname](#ssh_settings_gss_hostname-property) | The GSS host name, in form of a FQDN (e. | | [ssh_settings_gss_lib](#ssh_settings_gss_lib-property) | A path to the GSS-API library (DLL or SO). | | [ssh_settings_gss_mechanisms](#ssh_settings_gss_mechanisms-property) | A comma-separated list of GSS mechanisms to use. | | [ssh_settings_gss_protocols](#ssh_settings_gss_protocols-property) | A comma-separated list of SSPI protocols. | | [ssh_settings_handshake_timeout](#ssh_settings_handshake_timeout-property) | Specifies the maximal time for the SSH handshake to proceed, in seconds. | | [ssh_settings_kex_algorithms](#ssh_settings_kex_algorithms-property) | A list of key exchange algorithms separated with commas or semicolons. | | [ssh_settings_mac_algorithms](#ssh_settings_mac_algorithms-property) | A list of MAC (for message authentication code ) algorithms separated with commas or semicolons. | | [ssh_settings_max_ssh_packet_size](#ssh_settings_max_ssh_packet_size-property) | Specifies the maximum length of one SSH packet in bytes. | | [ssh_settings_min_window_size](#ssh_settings_min_window_size-property) | Specifies the minimal internal window size. | | [ssh_settings_obfuscate_handshake](#ssh_settings_obfuscate_handshake-property) | Enables or disables handshake obfuscation. | | [ssh_settings_obfuscation_password](#ssh_settings_obfuscation_password-property) | Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. | | [ssh_settings_public_key_algorithms](#ssh_settings_public_key_algorithms-property) | A list of public key algorithms separated with commas or semicolons. | | [ssh_settings_request_password_change](#ssh_settings_request_password_change-property) | Whether to request a password change when connecting. | | [ssh_settings_software_name](#ssh_settings_software_name-property) | The name to be used by the class to identify itself. | | [ssh_settings_trust_all_keys](#ssh_settings_trust_all_keys-property) | Enables or disables explicit trust to all server keys. | | [ssh_settings_use_auth_agent](#ssh_settings_use_auth_agent-property) | Enables or disables the use of external key agent, such as Putty key agent. | | [ssh_settings_versions](#ssh_settings_versions-property) | Specifies enabled SSH protocol versions (1 or 2). | | [trusted_keys_file](#trusted_keys_file-property) | A file containing the keys of authorized servers. | | [upload_block_size](#upload_block_size-property) | The upload block size in bytes. | | [username](#username-property) | The client's username to authenticate to the server. | | [use_utf8](#use_utf8-property) | Enables UTF8 for all string content. | | [version](#version-property) | The SFTP version negotiated. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [absolute_path](#absolute_path-method) | Requests the absolute path for a relative path. | | [change_dir](#change_dir-method) | Changes current working directory on the server. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [connect](#connect-method) | Connects to an SFTP server. | | [create_link](#create_link-method) | Creates a symbolic or hard link to a remote file. | | [delete_dir](#delete_dir-method) | Removes directory from the SFTP server. | | [delete_file](#delete_file-method) | Deletes a file from the SFTP server. | | [delete_files](#delete_files-method) | Deletes a group of files from the SFTP server. | | [dir_exists](#dir_exists-method) | Checks if a directory exists on the SFTP server. | | [disconnect](#disconnect-method) | Disconnects from the SFTP server. | | [do_action](#do_action-method) | Performs an additional action. | | [download_bytes](#download_bytes-method) | Downloads a file from the server into an array of bytes. | | [download_file](#download_file-method) | Downloads a file from the SFTP server. | | [download_files](#download_files-method) | Downloads multiple files from the SFTP server. | | [execute_ssh_command](#execute_ssh_command-method) | Sends an SSH command to the server in the middle of SFTP session. | | [extension_cmd](#extension_cmd-method) | Sends an extension command to the server. | | [file_exists](#file_exists-method) | Checks whether a file exists on the server. | | [get_current_dir](#get_current_dir-method) | Returns the current directory on the SFTP server. | | [get_file_size](#get_file_size-method) | Checks the size of a remote file. | | [list_dir](#list_dir-method) | Lists the content of the current remote directory. | | [make_dir](#make_dir-method) | Creates a new directory on the server. | | [rename_file](#rename_file-method) | Renames a file. | | [request_attributes](#request_attributes-method) | Requests attributes of the remote file. | | [reset](#reset-method) | Resets the class settings. | | [set_attributes](#set_attributes-method) | Sets the attributes upon a remote file. | | [upload_bytes](#upload_bytes-method) | Uploads a byte array to the server. | | [upload_file](#upload_file-method) | Uploads a file to the server. | | [upload_files](#upload_files-method) | Uploads multiple files to the server. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_auth_attempt](#on_auth_attempt-event) | Fires when an authentication attempt is performed. | | [on_auth_failed](#on_auth_failed-event) | Fires if an authentication attempt fails. | | [on_auth_succeeded](#on_auth_succeeded-event) | Reports a successful authentication. | | [on_banner](#on_banner-event) | Reports the receipt of the Welcome message from the server. | | [on_disconnect](#on_disconnect-event) | Reports SFTP connection closure. | | [on_error](#on_error-event) | Information about errors during SFTP connection. | | [on_external_sign](#on_external_sign-event) | Handles remote or external signing initiated by the SignExternal method or other source. | | [on_file_name_change_needed](#on_file_name_change_needed-event) | Asks the application for a new file name. | | [on_file_operation](#on_file_operation-event) | Signifies the start of a file transfer operation. | | [on_file_operation_result](#on_file_operation_result-event) | Signifies the completion of a file transfer operation. | | [on_known_key_received](#on_known_key_received-event) | Signals that the server has introduced itself with a known key. | | [on_list_entry](#on_list_entry-event) | Reports a directory listing entry to the application. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | | [on_password_change_request](#on_password_change_request-event) | Signals that the server requests a password change. | | [on_private_key_needed](#on_private_key_needed-event) | Asks the application for the client's private key. | | [on_progress](#on_progress-event) | Fires periodically during the data transfer. | | [on_unknown_key_received](#on_unknown_key_received-event) | Signals that the server has introduced itself with an unknown key. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AdjustFileTimes](#AdjustFileTimes) | Whether file times should be adjusted after upload/download. | | [AllAlgorithms](#AllAlgorithms) | Returns the list of algorithms enabled in the class. | | [ASCIIMode](#ASCIIMode) | Whether ASCII transfer mode is used. | | [AvailableSpace](#AvailableSpace) | Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work. | | [CaseConversion](#CaseConversion) | Whether file names and paths should be case-converted. | | [CaseSensitive](#CaseSensitive) | Specifies if file paths are case-sensitive. | | [CloseQuietly](#CloseQuietly) | Controls the client's approach to session closure. | | [CommandTimeout](#CommandTimeout) | Specifies the command timeout. | | [CompressionAlgorithms](#CompressionAlgorithms) | Returns the list of compression algorithms enabled in the class. | | [CopyMode](#CopyMode) | Tunes up the post-transfer action for batch uploads. | | [DefaultTransferBlock](#DefaultTransferBlock) | Specifies the default transfer block size. | | [DefOutboundBlockSize](#DefOutboundBlockSize) | The default outbound block size. | | [DisablePacketFragmentation](#DisablePacketFragmentation) | Enables or disables SSH packet fragmentation. | | [EarlyIdString](#EarlyIdString) | Enables the proactive approach to SSH handshake. | | [EncryptionAlgorithms](#EncryptionAlgorithms) | Returns the list of encryption algorithms enabled in the class. | | [ErrorOrigin](#ErrorOrigin) | Specifies whether the error is local or remote. | | [ErrorSeverity](#ErrorSeverity) | Specifies whether the error is fatal. | | [FileHash](#FileHash) | Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work. | | [HashAlgorithm](#HashAlgorithm) | The hash algorithm to use for the protocol operations. | | [HomeDir](#HomeDir) | Returns a user's home directory. This protocol extension must be supported by the server for this request to work. | | [IncomingSpeedLimit](#IncomingSpeedLimit) | Specifies incoming speed limit. | | [KeepAlivePeriod](#KeepAlivePeriod) | The inactivity period after which a keep-alive signal will be sent. | | [KexAlgorithms](#KexAlgorithms) | Returns the list of key exchange algorithms enabled in the class. | | [LocalCharset](#LocalCharset) | Charset used on the client machine. | | [LocalNewLineConvention](#LocalNewLineConvention) | A character string for the end of line (EOL) indication on the local machine. | | [MacAlgorithms](#MacAlgorithms) | Returns the list of MAC algorithms enabled in the class. | | [NewLineConvention](#NewLineConvention) | A character string for the end of line (EOL) indication on the server. | | [OutgoingSpeedLimit](#OutgoingSpeedLimit) | Specifies incoming speed limit. | | [PreserveExistingFileTimes](#PreserveExistingFileTimes) | Whether original file times should be restored upon transfer. | | [PublicKeyAlgorithms](#PublicKeyAlgorithms) | Returns the list of public key algorithms enabled in the class. | | [RedirectStdErr](#RedirectStdErr) | Whether to redirect output to StdErr. | | [RemoteCharset](#RemoteCharset) | Charset used on the server. | | [SFTPBufferSize](#SFTPBufferSize) | The size of internal buffer used for data transfer. | | [SFTPServerExecutableLocations](#SFTPServerExecutableLocations) | Location of the SFTP server executable. | | [SocketRecvBufferSize](#SocketRecvBufferSize) | The inbound socket buffer size. | | [SocketSendBufferSize](#SocketSendBufferSize) | The outbound socket buffer size. | | [StatVFS](#StatVFS) | Returns VFS details. This protocol extension must be supported by the server for this request to work. | | [StdErrData](#StdErrData) | The buffer for writing StdErr data. | | [SuppressAuxTransferOps](#SuppressAuxTransferOps) | TBD. | | [TempFolder](#TempFolder) | Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TreatZeroSizeAsUndefined](#TreatZeroSizeAsUndefined) | Whether zero size returned by STAT should be considered as undefined. | | [TryPasswordAuth](#TryPasswordAuth) | Specifies whether the class should attempt the password-based authentication if no password is set. | | [UseStrictKeyExchange](#UseStrictKeyExchange) | Specifies how strict key exchange is supported. | | [UseTruncateFlagOnUpload](#UseTruncateFlagOnUpload) | whether to use the 'truncate' flag on file upload. | | [UseUTF8OnV3](#UseUTF8OnV3) | Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # auth_attempts property Specifies the number of SSH authentication attempts. ## Syntax ```text def get_auth_attempts() -> int: ... def set_auth_attempts(value: int) -> None: ... auth_attempts = property(get_auth_attempts, set_auth_attempts) ``` ## Default Value 1 ## Remarks Use this property to specify the number of authentication attempts to try. The [on_auth_failed](#on_auth_failed-event) event is fired for every failed attempt. # auto_adjust_transfer_block property Specifies whether to adjust the send and receive buffer sizes automatically. ## Syntax ```text def get_auto_adjust_transfer_block() -> bool: ... def set_auto_adjust_transfer_block(value: bool) -> None: ... auto_adjust_transfer_block = property(get_auto_adjust_transfer_block, set_auto_adjust_transfer_block) ``` ## Default Value TRUE ## Remarks Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds. Use [download_block_size](#download_block_size-property), [upload_block_size](#upload_block_size-property), and [pipeline_length](#pipeline_length-property) properties to adjust the transfer settings manually. # conflict_resolution_mode property Defines the approach that should be used to resolve various conflicts during batch processing. ## Syntax ```text def get_conflict_resolution_mode() -> int: ... def set_conflict_resolution_mode(value: int) -> None: ... conflict_resolution_mode = property(get_conflict_resolution_mode, set_conflict_resolution_mode) ``` ## Possible Values ```text 0 # Overwrite1 # Skip2 # AppendToEnd3 # Resume4 # OverwriteIfDiffSize5 # SaveWithNewName6 # RenameExistingTarget ``` ## Default Value 0 ## Remarks Use this property to specify the approach to use when landing in conflicting transfer situations. | | | | | --- | --- | --- | | cftmOverwrite | 0 | | | cftmSkip | 1 | | | cftmAppendToEnd | 2 | The signature is corrupted | | cftmResume | 3 | | | cftmOverwriteIfDiffSize | 4 | | | cftmSaveWithNewName | 5 | | | cftmRenameExistingTarget | 5 | | # connected property Indicates if the client is connected to the SFTP server. ## Syntax ```text def get_connected() -> bool: ... connected = property(get_connected, None) ``` ## Default Value FALSE ## Remarks Use this read-only property to check whether the client is connected to the server. This property is read-only. # conn_info_client_key_algorithm property Specifies the client's key algorithm. ## Syntax ```text def get_conn_info_client_key_algorithm() -> str: ... conn_info_client_key_algorithm = property(get_conn_info_client_key_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the client's key algorithm. This property is read-only. # conn_info_client_key_bits property Specifies the length of the client's key. ## Syntax ```text def get_conn_info_client_key_bits() -> int: ... conn_info_client_key_bits = property(get_conn_info_client_key_bits, None) ``` ## Default Value 0 ## Remarks Specifies the length of the client's key. This property is read-only. # conn_info_client_key_fingerprint property The fingerprint (hash value) of the client's public key. ## Syntax ```text def get_conn_info_client_key_fingerprint() -> str: ... conn_info_client_key_fingerprint = property(get_conn_info_client_key_fingerprint, None) ``` ## Default Value "" ## Remarks The fingerprint (hash value) of the client's public key. This property is read-only. # conn_info_close_reason property Contains the line sent by the server just before closing the connection. ## Syntax ```text def get_conn_info_close_reason() -> str: ... conn_info_close_reason = property(get_conn_info_close_reason, None) ``` ## Default Value "" ## Remarks Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully. This property is read-only. # conn_info_compression_algorithm_inbound property Compression algorithm for the incoming traffic. ## Syntax ```text def get_conn_info_compression_algorithm_inbound() -> str: ... conn_info_compression_algorithm_inbound = property(get_conn_info_compression_algorithm_inbound, None) ``` ## Default Value "" ## Remarks Compression algorithm for the incoming traffic. This property is read-only. # conn_info_compression_algorithm_outbound property Compression algorithm for the outgoing traffic. ## Syntax ```text def get_conn_info_compression_algorithm_outbound() -> str: ... conn_info_compression_algorithm_outbound = property(get_conn_info_compression_algorithm_outbound, None) ``` ## Default Value "" ## Remarks Compression algorithm for the outgoing traffic. This property is read-only. # conn_info_encryption_algorithm_inbound property Encryption algorithm for the incoming traffic. ## Syntax ```text def get_conn_info_encryption_algorithm_inbound() -> str: ... conn_info_encryption_algorithm_inbound = property(get_conn_info_encryption_algorithm_inbound, None) ``` ## Default Value "" ## Remarks Encryption algorithm for the incoming traffic. This property is read-only. # conn_info_encryption_algorithm_outbound property Encryption algorithm for the outgoing traffic. ## Syntax ```text def get_conn_info_encryption_algorithm_outbound() -> str: ... conn_info_encryption_algorithm_outbound = property(get_conn_info_encryption_algorithm_outbound, None) ``` ## Default Value "" ## Remarks Encryption algorithm for the outgoing traffic. This property is read-only. # conn_info_inbound_encryption_key_bits property Specifies the length of the key used to encrypt the incoming traffic. ## Syntax ```text def get_conn_info_inbound_encryption_key_bits() -> int: ... conn_info_inbound_encryption_key_bits = property(get_conn_info_inbound_encryption_key_bits, None) ``` ## Default Value 0 ## Remarks Specifies the length of the key used to encrypt the incoming traffic. This property is read-only. # conn_info_kex_algorithm property The key exchange algorithm used during the SSH handshake. ## Syntax ```text def get_conn_info_kex_algorithm() -> str: ... conn_info_kex_algorithm = property(get_conn_info_kex_algorithm, None) ``` ## Default Value "" ## Remarks The key exchange algorithm used during the SSH handshake. This property is read-only. # conn_info_kex_bits property The number of bits used by the key exchange algorithm. ## Syntax ```text def get_conn_info_kex_bits() -> int: ... conn_info_kex_bits = property(get_conn_info_kex_bits, None) ``` ## Default Value 0 ## Remarks The number of bits used by the key exchange algorithm. This property is read-only. # conn_info_kex_lines property The contents of the received KexInit packet. ## Syntax ```text def get_conn_info_kex_lines() -> str: ... conn_info_kex_lines = property(get_conn_info_kex_lines, None) ``` ## Default Value "" ## Remarks The contents of the received KexInit packet. KexInit packet contains the list of algorithms supported by the remote party. This property is read-only. # conn_info_mac_algorithm_inbound property MAC algorithm used for the incoming connection. ## Syntax ```text def get_conn_info_mac_algorithm_inbound() -> str: ... conn_info_mac_algorithm_inbound = property(get_conn_info_mac_algorithm_inbound, None) ``` ## Default Value "" ## Remarks MAC algorithm used for the incoming connection. This property is read-only. # conn_info_mac_algorithm_outbound property MAC algorithm used for outbound connection. ## Syntax ```text def get_conn_info_mac_algorithm_outbound() -> str: ... conn_info_mac_algorithm_outbound = property(get_conn_info_mac_algorithm_outbound, None) ``` ## Default Value "" ## Remarks MAC algorithm used for outbound connection. This property is read-only. # conn_info_outbound_encryption_key_bits property Specifies the length of the key used to encrypt the outgoing traffic. ## Syntax ```text def get_conn_info_outbound_encryption_key_bits() -> int: ... conn_info_outbound_encryption_key_bits = property(get_conn_info_outbound_encryption_key_bits, None) ``` ## Default Value 0 ## Remarks Specifies the length of the key used to encrypt the outgoing traffic. This property is read-only. # conn_info_public_key_algorithm property Specifies the public key algorithm which was used during the SSH handshake. ## Syntax ```text def get_conn_info_public_key_algorithm() -> str: ... conn_info_public_key_algorithm = property(get_conn_info_public_key_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the public key algorithm which was used during the SSH handshake. This property is read-only. # conn_info_remote_address property The client's IP address. ## Syntax ```text def get_conn_info_remote_address() -> str: ... conn_info_remote_address = property(get_conn_info_remote_address, None) ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only. # conn_info_remote_port property The remote port of the client connection. ## Syntax ```text def get_conn_info_remote_port() -> int: ... conn_info_remote_port = property(get_conn_info_remote_port, None) ``` ## Default Value 0 ## Remarks The remote port of the client connection. This property is read-only. # conn_info_remote_software_name property Returns the name (self-advertised) of the SSH software running on the other side. ## Syntax ```text def get_conn_info_remote_software_name() -> str: ... conn_info_remote_software_name = property(get_conn_info_remote_software_name, None) ``` ## Default Value "" ## Remarks Returns the name (self-advertised) of the SSH software running on the other side. This property is read-only. # conn_info_server_key_algorithm property Specifies the server's key algorithm. ## Syntax ```text def get_conn_info_server_key_algorithm() -> str: ... conn_info_server_key_algorithm = property(get_conn_info_server_key_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the server's key algorithm. This property is read-only. # conn_info_server_key_bits property Specifies the number of bits in the server's key. ## Syntax ```text def get_conn_info_server_key_bits() -> int: ... conn_info_server_key_bits = property(get_conn_info_server_key_bits, None) ``` ## Default Value 0 ## Remarks Specifies the number of bits in the server's key. This property is read-only. # conn_info_server_key_fingerprint property The fingerprint (hash value) of the server's public key. ## Syntax ```text def get_conn_info_server_key_fingerprint() -> str: ... conn_info_server_key_fingerprint = property(get_conn_info_server_key_fingerprint, None) ``` ## Default Value "" ## Remarks The fingerprint (hash value) of the server's public key. This property is read-only. # conn_info_total_bytes_received property Returns the total number of bytes received over this connection. ## Syntax ```text def get_conn_info_total_bytes_received() -> int: ... conn_info_total_bytes_received = property(get_conn_info_total_bytes_received, None) ``` ## Default Value 0 ## Remarks Returns the total number of bytes received over this connection. This property is read-only. # conn_info_total_bytes_sent property Returns the total number of bytes sent over this connection. ## Syntax ```text def get_conn_info_total_bytes_sent() -> int: ... conn_info_total_bytes_sent = property(get_conn_info_total_bytes_sent, None) ``` ## Default Value 0 ## Remarks Returns the total number of bytes sent over this connection. This property is read-only. # conn_info_version property Specifies SSH protocol version. ## Syntax ```text def get_conn_info_version() -> int: ... conn_info_version = property(get_conn_info_version, None) ``` ## Default Value 2 ## Remarks Specifies SSH protocol version. This property is read-only. # curr_list_entry_access_time property Contains the last access time for this file, in UTC. ## Syntax ```text def get_curr_list_entry_access_time() -> str: ... curr_list_entry_access_time = property(get_curr_list_entry_access_time, None) ``` ## Default Value "" ## Remarks Contains the last access time for this file, in UTC. This property is read-only. # curr_list_entry_creation_time property Contains this file's creation time, in UTC. ## Syntax ```text def get_curr_list_entry_creation_time() -> str: ... curr_list_entry_creation_time = property(get_curr_list_entry_creation_time, None) ``` ## Default Value "" ## Remarks Contains this file's creation time, in UTC. This property is read-only. # curr_list_entry_entry_format property The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 . ## Syntax ```text def get_curr_list_entry_entry_format() -> int: ... curr_list_entry_entry_format = property(get_curr_list_entry_entry_format, None) ``` ## Possible Values ```text 0 # Unknown1 # Unix2 # Windows3 # MLSD ``` ## Default Value 0 ## Remarks The file listing format: | | | | --- | --- | | cfefUnknown | 0 | | cfefUnix | 1 | | cfefWindows | 2 | | cfefMLSD | 3 | This property is read-only. # curr_list_entry_file_type property The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 . ## Syntax ```text def get_curr_list_entry_file_type() -> int: ... curr_list_entry_file_type = property(get_curr_list_entry_file_type, None) ``` ## Possible Values ```text 0 # Unknown1 # Directory2 # File3 # Symlink4 # Special5 # CurrentDirectory6 # ParentDirectory7 # Socket8 # CharDevice9 # BlockDevice10 # FIFO ``` ## Default Value 0 ## Remarks The type of the entry: | | | | --- | --- | | fetUnknown | 0 | | fetDirectory | 1 | | fetFile | 2 | | fetSymlink | 3 | | fetSpecial | 4 | | fetCurrentDirectory | 5 | | fetParentDirectory | 6 | | fetSocket | 7 | | fetCharDevice | 8 | | fetBlockDevice | 9 | | fetFIFO | 10 | This property is read-only. # curr_list_entry_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_curr_list_entry_handle() -> int: ... curr_list_entry_handle = property(get_curr_list_entry_handle, None) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only. # curr_list_entry_modification_time property File last modification date/time. ## Syntax ```text def get_curr_list_entry_modification_time() -> str: ... curr_list_entry_modification_time = property(get_curr_list_entry_modification_time, None) ``` ## Default Value "" ## Remarks File last modification date/time. This property is read-only. # curr_list_entry_name property The file or directory name. ## Syntax ```text def get_curr_list_entry_name() -> str: ... curr_list_entry_name = property(get_curr_list_entry_name, None) ``` ## Default Value "" ## Remarks The file or directory name. This property is read-only. # curr_list_entry_path property The full path to the file or directory. ## Syntax ```text def get_curr_list_entry_path() -> str: ... curr_list_entry_path = property(get_curr_list_entry_path, None) ``` ## Default Value "" ## Remarks The full path to the file or directory. This property is read-only. # curr_list_entry_principal property Specifies the owner of the file/directory. ## Syntax ```text def get_curr_list_entry_principal() -> str: ... curr_list_entry_principal = property(get_curr_list_entry_principal, None) ``` ## Default Value "" ## Remarks Specifies the owner of the file/directory. Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings. This property is read-only. # curr_list_entry_size property File size in bytes. ## Syntax ```text def get_curr_list_entry_size() -> int: ... curr_list_entry_size = property(get_curr_list_entry_size, None) ``` ## Default Value 0 ## Remarks File size in bytes. This property is read-only. # curr_list_entry_unix_perms property The file Unix permissions bit mask (e. ## Syntax ```text def get_curr_list_entry_unix_perms() -> int: ... curr_list_entry_unix_perms = property(get_curr_list_entry_unix_perms, None) ``` ## Default Value 511 ## Remarks The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)). This property is read-only. # curr_list_entry_unparsed_name property The unparsed entry as returned by the server. ## Syntax ```text def get_curr_list_entry_unparsed_name() -> str: ... curr_list_entry_unparsed_name = property(get_curr_list_entry_unparsed_name, None) ``` ## Default Value "" ## Remarks The unparsed entry as returned by the server. Sometimes this is also known as "long name". This property is read-only. # download_block_size property The download block size in bytes. ## Syntax ```text def get_download_block_size() -> int: ... def set_download_block_size(value: int) -> None: ... download_block_size = property(get_download_block_size, set_download_block_size) ``` ## Default Value 65536 ## Remarks Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings ([auto_adjust_transfer_block](#auto_adjust_transfer_block-property)) don't work. # external_crypto_async_document_id property Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax ```text def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ... external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id) ``` ## Default Value "" ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. # external_crypto_custom_params property Custom parameters to be passed to the signing service (uninterpreted). ## Syntax ```text def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ... external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params) ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). # external_crypto_data property Additional data to be included in the async state and mirrored back by the requestor. ## Syntax ```text def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ... external_crypto_data = property(get_external_crypto_data, set_external_crypto_data) ``` ## Default Value "" ## Remarks Additional data to be included in the async state and mirrored back by the requestor. # external_crypto_external_hash_calculation property Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax ```text def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ... external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation) ``` ## Default Value FALSE ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. # external_crypto_hash_algorithm property Specifies the request's signature hash algorithm. ## Syntax ```text def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ... external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm) ``` ## Default Value "SHA256" ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | # external_crypto_key_id property The ID of the pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ... external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id) ``` ## Default Value "" ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [external_crypto_key_secret](#external_crypto_key_secret-property) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` # external_crypto_key_secret property The pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ... external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret) ``` ## Default Value "" ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [external_crypto_key_id](#external_crypto_key_id-property) topic. # external_crypto_method property Specifies the asynchronous signing method. ## Syntax ```text def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ... external_crypto_method = property(get_external_crypto_method, set_external_crypto_method) ``` ## Possible Values ```text 0 # PKCS11 # PKCS7 ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | # external_crypto_mode property Specifies the external cryptography mode. ## Syntax ```text def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ... external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode) ``` ## Possible Values ```text 0 # Default1 # Disabled2 # Generic3 # DCAuth4 # DCAuthJSON ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | # external_crypto_public_key_algorithm property Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax ```text def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ... external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm) ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | # fips_mode property Reserved. ## Syntax ```text def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ... fips_mode = property(get_fips_mode, set_fips_mode) ``` ## Default Value FALSE ## Remarks This property is reserved for future use. # force_compression property Enforces compression for the SSH layer. ## Syntax ```text def get_force_compression() -> bool: ... def set_force_compression(value: bool) -> None: ... force_compression = property(get_force_compression, set_force_compression) ``` ## Default Value FALSE ## Remarks Set this property before opening a connection to enforce compression of the SSH packets. # key_fingerprint_sha1 property Contains the SHA-1 fingerprint (hash) of the key. ## Syntax ```text def get_key_fingerprint_sha1() -> str: ... key_fingerprint_sha1 = property(get_key_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks Contains the SHA-1 fingerprint (hash) of the key. This property is read-only. # key_fingerprint_sha256 property Contains the SHA-256 fingerprint (hash) of the key. ## Syntax ```text def get_key_fingerprint_sha256() -> str: ... key_fingerprint_sha256 = property(get_key_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks Contains the SHA-256 fingerprint (hash) of the key. This property is read-only. # key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_key_handle() -> int: ... def set_key_handle(value: int) -> None: ... key_handle = property(get_key_handle, set_key_handle) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # max_sftp_version property Higher SFTP version to support. ## Syntax ```text def get_max_sftp_version() -> int: ... def set_max_sftp_version(value: int) -> None: ... max_sftp_version = property(get_max_sftp_version, set_max_sftp_version) ``` ## Default Value 6 ## Remarks max_sftp_version and [min_sftp_version](#min_sftp_version-property) properties control the range of SFTP protocol versions supported by this client. # min_sftp_version property Lower SFTP version to support. ## Syntax ```text def get_min_sftp_version() -> int: ... def set_min_sftp_version(value: int) -> None: ... min_sftp_version = property(get_min_sftp_version, set_min_sftp_version) ``` ## Default Value 0 ## Remarks [max_sftp_version](#max_sftp_version-property) and min_sftp_version properties control the range of SFTP protocol versions to be supported by this client. # password property Specifies user's authentication password. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## Default Value "" ## Remarks Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types. # pipeline_length property The number of parallelized transfer requests. ## Syntax ```text def get_pipeline_length() -> int: ... def set_pipeline_length(value: int) -> None: ... pipeline_length = property(get_pipeline_length, set_pipeline_length) ``` ## Default Value 32 ## Remarks This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers. Typically you will only need to adjust this property if the default transfer settings ([auto_adjust_transfer_block](#auto_adjust_transfer_block-property)) don't work. # proxy_address property The IP address of the proxy server. ## Syntax ```text def get_proxy_address() -> str: ... def set_proxy_address(value: str) -> None: ... proxy_address = property(get_proxy_address, set_proxy_address) ``` ## Default Value "" ## Remarks The IP address of the proxy server. # proxy_authentication property The authentication type used by the proxy server. ## Syntax ```text def get_proxy_authentication() -> int: ... def set_proxy_authentication(value: int) -> None: ... proxy_authentication = property(get_proxy_authentication, set_proxy_authentication) ``` ## Possible Values ```text 0 # NoAuthentication1 # Basic2 # Digest3 # NTLM ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | # proxy_password property The password to authenticate to the proxy server. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. # proxy_port property The port on the proxy server to connect to. ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. # proxy_type property The type of the proxy server. ## Syntax ```text def get_proxy_type() -> int: ... def set_proxy_type(value: int) -> None: ... proxy_type = property(get_proxy_type, set_proxy_type) ``` ## Possible Values ```text 0 # None1 # Socks42 # Socks53 # WebTunnel4 # HTTP ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | # proxy_request_headers property Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax ```text def get_proxy_request_headers() -> str: ... def set_proxy_request_headers(value: str) -> None: ... proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers) ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. # proxy_response_body property Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax ```text def get_proxy_response_body() -> str: ... def set_proxy_response_body(value: str) -> None: ... proxy_response_body = property(get_proxy_response_body, set_proxy_response_body) ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. # proxy_response_headers property Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax ```text def get_proxy_response_headers() -> str: ... def set_proxy_response_headers(value: str) -> None: ... proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers) ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. # proxy_use_ipv6 property Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax ```text def get_proxy_use_ipv6() -> bool: ... def set_proxy_use_ipv6(value: bool) -> None: ... proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6) ``` ## Default Value FALSE ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. # proxy_username property Specifies the username credential for proxy authentication. ## Syntax ```text def get_proxy_username() -> str: ... def set_proxy_username(value: str) -> None: ... proxy_username = property(get_proxy_username, set_proxy_username) ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. # server_key_algorithm property Specifies the key algorithm. ## Syntax ```text def get_server_key_algorithm() -> str: ... server_key_algorithm = property(get_server_key_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the key algorithm. The following key algorithms are currently supported and can be returned by this property: - RSA - DSS - ECDSA - EDDSA - MLDSA - ECDSA-SK - EDDSA-SK This property is read-only. # server_key_bits property The number of bits in the key: the more the better, 2048 or 4096 are typical values. ## Syntax ```text def get_server_key_bits() -> int: ... server_key_bits = property(get_server_key_bits, None) ``` ## Default Value 0 ## Remarks The number of bits in the key: the more the better, 2048 or 4096 are typical values. This property is read-only. # server_key_comment property The comment for the public key. ## Syntax ```text def get_server_key_comment() -> str: ... server_key_comment = property(get_server_key_comment, None) ``` ## Default Value "" ## Remarks The comment for the public key. This property is read-only. # server_key_curve property Specifies the elliptical curve when EC cryptography is used. ## Syntax ```text def get_server_key_curve() -> str: ... server_key_curve = property(get_server_key_curve, None) ``` ## Default Value "" ## Remarks Specifies the elliptical curve when EC cryptography is used. The following curves are currently supported: - NISTP256 - NISTP384 - NISTP521 - NISTK163 - NISTP192 - NISTP224 - NISTK233 - NISTB233 - NISTK283 - NISTK409 - NISTB409 - NISTK571 - CURVE25519 (EdDSA curve) - CURVE448 (EdDSA curve) This property is read-only. # server_key_extractable property Whether the key is extractable (e. ## Syntax ```text def get_server_key_extractable() -> bool: ... server_key_extractable = property(get_server_key_extractable, None) ``` ## Default Value FALSE ## Remarks Whether the key is extractable (e.g., from a security token), or not. This property is read-only. # server_key_fingerprint_md5 property Contains the MD5 fingerprint (hash) of the key. ## Syntax ```text def get_server_key_fingerprint_md5() -> str: ... server_key_fingerprint_md5 = property(get_server_key_fingerprint_md5, None) ``` ## Default Value "" ## Remarks Contains the MD5 fingerprint (hash) of the key. This property is read-only. # server_key_fingerprint_sha1 property Contains the SHA-1 fingerprint (hash) of the key. ## Syntax ```text def get_server_key_fingerprint_sha1() -> str: ... server_key_fingerprint_sha1 = property(get_server_key_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks Contains the SHA-1 fingerprint (hash) of the key. This property is read-only. # server_key_fingerprint_sha256 property Contains the SHA-256 fingerprint (hash) of the key. ## Syntax ```text def get_server_key_fingerprint_sha256() -> str: ... server_key_fingerprint_sha256 = property(get_server_key_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks Contains the SHA-256 fingerprint (hash) of the key. This property is read-only. # server_key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_server_key_handle() -> int: ... server_key_handle = property(get_server_key_handle, None) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only. # server_key_key_format property Specifies the format in which the key is stored. ## Syntax ```text def get_server_key_key_format() -> int: ... server_key_key_format = property(get_server_key_key_format, None) ``` ## Possible Values ```text 0 # OpenSSH1 # OpenSSH22 # IETF3 # PuTTY4 # X5095 # Binary6 # SSH17 # PGP8 # PKCS89 # PuTTY310 # OpenSSHCert ``` ## Default Value 0 ## Remarks Specifies the format in which the key is stored. | | | | | --- | --- | --- | | ckfOpenSSH | 0 | | | ckfOpenSSH2 | 1 | | | ckfIETF | 2 | | | ckfPuTTY | 3 | | | ckfX509 | 4 | | | ckfBinary | 5 | | | ckfSSH1 | 6 | | | ckfPGP | 7 | | | ckfPKCS8 | 8 | | | ckfPuTTY3 | 9 | | | ckfOpenSSHCert | 10 | | This property is read-only. # server_key_key_protection_algorithm property Specifies the key protection algorithm. ## Syntax ```text def get_server_key_key_protection_algorithm() -> str: ... server_key_key_protection_algorithm = property(get_server_key_key_protection_algorithm, None) ``` ## Default Value "" ## Remarks Specifies the key protection algorithm. This property is read-only. # server_key_private property Whether this key is a private key or not. ## Syntax ```text def get_server_key_private() -> bool: ... server_key_private = property(get_server_key_private, None) ``` ## Default Value FALSE ## Remarks Whether this key is a private key or not. This property is read-only. # server_key_public property Whether this key is a public key or not. ## Syntax ```text def get_server_key_public() -> bool: ... server_key_public = property(get_server_key_public, None) ``` ## Default Value FALSE ## Remarks Whether this key is a public key or not. This property is read-only. # server_key_subject property Specifies the public key owner (subject). ## Syntax ```text def get_server_key_subject() -> str: ... server_key_subject = property(get_server_key_subject, None) ``` ## Default Value "" ## Remarks Specifies the public key owner (subject). This property is used only for IETF-keys. This property is read-only. # socket_dns_mode property Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. ## Syntax ```text def get_socket_dns_mode() -> int: ... def set_socket_dns_mode(value: int) -> None: ... socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode) ``` ## Possible Values ```text 0 # Auto1 # Platform2 # Own3 # OwnSecure ``` ## Default Value 0 ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | # socket_dns_port property Specifies the port number to be used for sending queries to the DNS server. ## Syntax ```text def get_socket_dns_port() -> int: ... def set_socket_dns_port(value: int) -> None: ... socket_dns_port = property(get_socket_dns_port, set_socket_dns_port) ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. # socket_dns_query_timeout property The timeout (in milliseconds) for each DNS query. ## Syntax ```text def get_socket_dns_query_timeout() -> int: ... def set_socket_dns_query_timeout(value: int) -> None: ... socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout) ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. # socket_dns_servers property The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Syntax ```text def get_socket_dns_servers() -> str: ... def set_socket_dns_servers(value: str) -> None: ... socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers) ``` ## Default Value "" ## Remarks The addresses of DNS servers to use for address resolution, separated by commas or semicolons. # socket_dns_total_timeout property The timeout (in milliseconds) for the whole resolution process. ## Syntax ```text def get_socket_dns_total_timeout() -> int: ... def set_socket_dns_total_timeout(value: int) -> None: ... socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout) ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. # socket_incoming_speed_limit property The maximum number of bytes to read from the socket, per second. ## Syntax ```text def get_socket_incoming_speed_limit() -> int: ... def set_socket_incoming_speed_limit(value: int) -> None: ... socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. # socket_local_address property The local network interface to bind the socket to. ## Syntax ```text def get_socket_local_address() -> str: ... def set_socket_local_address(value: str) -> None: ... socket_local_address = property(get_socket_local_address, set_socket_local_address) ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. # socket_local_port property The local port number to bind the socket to. ## Syntax ```text def get_socket_local_port() -> int: ... def set_socket_local_port(value: int) -> None: ... socket_local_port = property(get_socket_local_port, set_socket_local_port) ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. # socket_outgoing_speed_limit property The maximum number of bytes to write to the socket, per second. ## Syntax ```text def get_socket_outgoing_speed_limit() -> int: ... def set_socket_outgoing_speed_limit(value: int) -> None: ... socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. # socket_timeout property The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax ```text def get_socket_timeout() -> int: ... def set_socket_timeout(value: int) -> None: ... socket_timeout = property(get_socket_timeout, set_socket_timeout) ``` ## Default Value 60000 ## Remarks The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). # socket_use_ipv6 property Enables or disables IP protocol version 6. ## Syntax ```text def get_socket_use_ipv6() -> bool: ... def set_socket_use_ipv6(value: bool) -> None: ... socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6) ``` ## Default Value FALSE ## Remarks Enables or disables IP protocol version 6. # ssh_settings_auto_adjust_ciphers property Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. ## Syntax ```text def get_ssh_settings_auto_adjust_ciphers() -> bool: ... def set_ssh_settings_auto_adjust_ciphers(value: bool) -> None: ... ssh_settings_auto_adjust_ciphers = property(get_ssh_settings_auto_adjust_ciphers, set_ssh_settings_auto_adjust_ciphers) ``` ## Default Value TRUE ## Remarks Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. # ssh_settings_base_configuration property Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. ## Syntax ```text def get_ssh_settings_base_configuration() -> int: ... def set_ssh_settings_base_configuration(value: int) -> None: ... ssh_settings_base_configuration = property(get_ssh_settings_base_configuration, set_ssh_settings_base_configuration) ``` ## Possible Values ```text 0 # Default1 # Compatible2 # ComprehensiveInsecure3 # HighlySecure ``` ## Default Value 0 ## Remarks Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. # ssh_settings_compression_algorithms property A list of session compression algorithms separated with commas or semicolons. ## Syntax ```text def get_ssh_settings_compression_algorithms() -> str: ... def set_ssh_settings_compression_algorithms(value: str) -> None: ... ssh_settings_compression_algorithms = property(get_ssh_settings_compression_algorithms, set_ssh_settings_compression_algorithms) ``` ## Default Value "" ## Remarks A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all compression algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below: - none - zlib - zlib@openssh.com # ssh_settings_compression_level property Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). ## Syntax ```text def get_ssh_settings_compression_level() -> int: ... def set_ssh_settings_compression_level(value: int) -> None: ... ssh_settings_compression_level = property(get_ssh_settings_compression_level, set_ssh_settings_compression_level) ``` ## Default Value 6 ## Remarks Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted. # ssh_settings_default_window_size property The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server. ## Syntax ```text def get_ssh_settings_default_window_size() -> int: ... def set_ssh_settings_default_window_size(value: int) -> None: ... ssh_settings_default_window_size = property(get_ssh_settings_default_window_size, set_ssh_settings_default_window_size) ``` ## Default Value 2048000 ## Remarks The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server. # ssh_settings_encryption_algorithms property A list of session encryption algorithms separated with commas or semicolons. ## Syntax ```text def get_ssh_settings_encryption_algorithms() -> str: ... def set_ssh_settings_encryption_algorithms(value: str) -> None: ... ssh_settings_encryption_algorithms = property(get_ssh_settings_encryption_algorithms, set_ssh_settings_encryption_algorithms) ``` ## Default Value "" ## Remarks A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all encryption algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below: - 3des-cbc - blowfish-cbc - twofish256-cbc - twofish192-cbc - twofish128-cbc - aes256-cbc - aes192-cbc - aes128-cbc - serpent256-cbc - serpent192-cbc - serpent128-cbc - arcfour - idea-cbc - cast128-cbc - none - des-cbc - aes128-ctr - aes192-ctr - aes256-ctr - 3des-ctr - blowfish-ctr - twofish128-ctr - twofish192-ctr - twofish256-ctr - serpent128-ctr - serpent192-ctr - serpent256-ctr - idea-ctr - cast128-ctr - arcfour128 - arcfour256 - aes128-gcm - aes256-gcm - aes128-gcm@openssh.com - aes256-gcm@openssh.com - chacha20-poly1305 - chacha20-poly1305@openssh.com # ssh_settings_force_compression property Whether the SSH client should explicitly request compression. ## Syntax ```text def get_ssh_settings_force_compression() -> bool: ... def set_ssh_settings_force_compression(value: bool) -> None: ... ssh_settings_force_compression = property(get_ssh_settings_force_compression, set_ssh_settings_force_compression) ``` ## Default Value FALSE ## Remarks Whether the SSH client should explicitly request compression. If *ForceCompression* is False, compression will be used only if the server doesn't support algorithms without compression. # ssh_settings_forward_auth_agent property Enables or disables auth agent forwarding. ## Syntax ```text def get_ssh_settings_forward_auth_agent() -> bool: ... def set_ssh_settings_forward_auth_agent(value: bool) -> None: ... ssh_settings_forward_auth_agent = property(get_ssh_settings_forward_auth_agent, set_ssh_settings_forward_auth_agent) ``` ## Default Value FALSE ## Remarks Enables or disables auth agent forwarding. This allows the class to connect to the second and subsequent servers in the chain with the key agent available on the client computer. # ssh_settings_gss_auth_types property A comma-separated list of authentication types. ## Syntax ```text def get_ssh_settings_gss_auth_types() -> str: ... def set_ssh_settings_gss_auth_types(value: str) -> None: ... ssh_settings_gss_auth_types = property(get_ssh_settings_gss_auth_types, set_ssh_settings_gss_auth_types) ``` ## Default Value "" ## Remarks A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex. # ssh_settings_gss_delegate_creds property Switches credential delegation on or off. ## Syntax ```text def get_ssh_settings_gss_delegate_creds() -> bool: ... def set_ssh_settings_gss_delegate_creds(value: bool) -> None: ... ssh_settings_gss_delegate_creds = property(get_ssh_settings_gss_delegate_creds, set_ssh_settings_gss_delegate_creds) ``` ## Default Value FALSE ## Remarks Switches credential delegation on or off. # ssh_settings_gss_hostname property The GSS host name, in form of a FQDN (e. ## Syntax ```text def get_ssh_settings_gss_hostname() -> str: ... def set_ssh_settings_gss_hostname(value: str) -> None: ... ssh_settings_gss_hostname = property(get_ssh_settings_gss_hostname, set_ssh_settings_gss_hostname) ``` ## Default Value "" ## Remarks The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com). # ssh_settings_gss_lib property A path to the GSS-API library (DLL or SO). ## Syntax ```text def get_ssh_settings_gss_lib() -> str: ... def set_ssh_settings_gss_lib(value: str) -> None: ... ssh_settings_gss_lib = property(get_ssh_settings_gss_lib, set_ssh_settings_gss_lib) ``` ## Default Value "" ## Remarks A path to the GSS-API library (DLL or SO). # ssh_settings_gss_mechanisms property A comma-separated list of GSS mechanisms to use. ## Syntax ```text def get_ssh_settings_gss_mechanisms() -> str: ... def set_ssh_settings_gss_mechanisms(value: str) -> None: ... ssh_settings_gss_mechanisms = property(get_ssh_settings_gss_mechanisms, set_ssh_settings_gss_mechanisms) ``` ## Default Value "" ## Remarks A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI. # ssh_settings_gss_protocols property A comma-separated list of SSPI protocols. ## Syntax ```text def get_ssh_settings_gss_protocols() -> str: ... def set_ssh_settings_gss_protocols(value: str) -> None: ... ssh_settings_gss_protocols = property(get_ssh_settings_gss_protocols, set_ssh_settings_gss_protocols) ``` ## Default Value "" ## Remarks A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM. # ssh_settings_handshake_timeout property Specifies the maximal time for the SSH handshake to proceed, in seconds. ## Syntax ```text def get_ssh_settings_handshake_timeout() -> int: ... def set_ssh_settings_handshake_timeout(value: int) -> None: ... ssh_settings_handshake_timeout = property(get_ssh_settings_handshake_timeout, set_ssh_settings_handshake_timeout) ``` ## Default Value 45 ## Remarks Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted. # ssh_settings_kex_algorithms property A list of key exchange algorithms separated with commas or semicolons. ## Syntax ```text def get_ssh_settings_kex_algorithms() -> str: ... def set_ssh_settings_kex_algorithms(value: str) -> None: ... ssh_settings_kex_algorithms = property(get_ssh_settings_kex_algorithms, set_ssh_settings_kex_algorithms) ``` ## Default Value "" ## Remarks A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all key exchange algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below: - diffie-hellman-group-exchange-sha1 - diffie-hellman-group1-sha1 - diffie-hellman-group14-sha1 - diffie-hellman-group-exchange-sha256 - rsa1024-sha1 - rsa2048-sha256 - ecdh-sha2-nistp256 - ecdh-sha2-nistp384 - ecdh-sha2-nistp521 - ecdh-sha2-nistk163 - ecdh-sha2-nistp192 - ecdh-sha2-nistp224 - ecdh-sha2-nistk233 - ecdh-sha2-nistb233 - ecdh-sha2-nistk283 - ecdh-sha2-nistk409 - ecdh-sha2-nistb409 - ecdh-sha2-nistt571 - ecdh-sha2-curve25519 - curve25519-sha256@libssh.org - curve448-sha512@libssh.org - diffie-hellman-group14-sha256 - diffie-hellman-group15-sha512 - diffie-hellman-group16-sha512 - diffie-hellman-group17-sha512 - diffie-hellman-group18-sha512 # ssh_settings_mac_algorithms property A list of MAC (for message authentication code ) algorithms separated with commas or semicolons. ## Syntax ```text def get_ssh_settings_mac_algorithms() -> str: ... def set_ssh_settings_mac_algorithms(value: str) -> None: ... ssh_settings_mac_algorithms = property(get_ssh_settings_mac_algorithms, set_ssh_settings_mac_algorithms) ``` ## Default Value "" ## Remarks A list of MAC (for *message authentication code*) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all MAC algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below: - hmac-sha1 - hmac-sha1-96 - hmac-md5 - hmac-md5-96 - none - hmac-ripemd160 - hmac-ripemd - hmac-ripemd160@openssh.com - hmac-sha256@ssh.com - hmac-sha256-96@ssh.com - umac-32@openssh.com - umac-64@openssh.com - umac-96@openssh.com - umac-128@openssh.com - hmac-sha2-256 - hmac-sha2-512 - aes128-gcm - aes256-gcm - chacha20-poly1305@openssh.com - hmac-sha2-256-etm@openssh.com - hmac-sha2-512-etm@openssh.com # ssh_settings_max_ssh_packet_size property Specifies the maximum length of one SSH packet in bytes. ## Syntax ```text def get_ssh_settings_max_ssh_packet_size() -> int: ... def set_ssh_settings_max_ssh_packet_size(value: int) -> None: ... ssh_settings_max_ssh_packet_size = property(get_ssh_settings_max_ssh_packet_size, set_ssh_settings_max_ssh_packet_size) ``` ## Default Value 262144 ## Remarks Specifies the maximum length of one SSH packet in bytes. # ssh_settings_min_window_size property Specifies the minimal internal window size. ## Syntax ```text def get_ssh_settings_min_window_size() -> int: ... def set_ssh_settings_min_window_size(value: int) -> None: ... ssh_settings_min_window_size = property(get_ssh_settings_min_window_size, set_ssh_settings_min_window_size) ``` ## Default Value 2048 ## Remarks Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data. # ssh_settings_obfuscate_handshake property Enables or disables handshake obfuscation. ## Syntax ```text def get_ssh_settings_obfuscate_handshake() -> bool: ... def set_ssh_settings_obfuscate_handshake(value: bool) -> None: ... ssh_settings_obfuscate_handshake = property(get_ssh_settings_obfuscate_handshake, set_ssh_settings_obfuscate_handshake) ``` ## Default Value FALSE ## Remarks Enables or disables handshake obfuscation. # ssh_settings_obfuscation_password property Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. ## Syntax ```text def get_ssh_settings_obfuscation_password() -> str: ... def set_ssh_settings_obfuscation_password(value: str) -> None: ... ssh_settings_obfuscation_password = property(get_ssh_settings_obfuscation_password, set_ssh_settings_obfuscation_password) ``` ## Default Value "" ## Remarks Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. # ssh_settings_public_key_algorithms property A list of public key algorithms separated with commas or semicolons. ## Syntax ```text def get_ssh_settings_public_key_algorithms() -> str: ... def set_ssh_settings_public_key_algorithms(value: str) -> None: ... ssh_settings_public_key_algorithms = property(get_ssh_settings_public_key_algorithms, set_ssh_settings_public_key_algorithms) ``` ## Default Value "" ## Remarks A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all public key algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below: - ssh-dss - ssh-rsa - x509v3-sign-rsa - x509v3-sign-dss - spki-sign-rsa, - spki-sign-dss - pgp-sign-rsa - pgp-sign-dss - ecdsa-sha2-nistp256 - ecdsa-sha2-nistp384 - ecdsa-sha2-nistp521 - ecdsa-sha2-nistk163 - ecdsa-sha2-nistp192 - ecdsa-sha2-nistp224 - ecdsa-sha2-nistk233 - ecdsa-sha2-nistb233 - ecdsa-sha2-nistk283 - ecdsa-sha2-nistk409 - ecdsa-sha2-nistb409 - ecdsa-sha2-nistt571, - ecdsa-sha2-curve25519 - x509v3-ssh-rsa - x509v3-ssh-dss - x509v3-rsa2048-sha256 - x509v3-ecdsa-sha2-nistp256 - x509v3-ecdsa-sha2-nistp384 - x509v3-ecdsa-sha2-nistp521 - x509v3-ecdsa-sha2-nistk163 - x509v3-ecdsa-sha2-nistp192 - x509v3-ecdsa-sha2-nistp224 - x509v3-ecdsa-sha2-nistk233 - x509v3-ecdsa-sha2-nistb233 - x509v3-ecdsa-sha2-nistk283 - x509v3-ecdsa-sha2-nistk409 - x509v3-ecdsa-sha2-nistb409 - x509v3-ecdsa-sha2-nistt571 - x509v3-ecdsa-sha2-curve25519 - ssh-ed25519 - ssh-ed448 - rsa-sha2-256 - rsa-sha2-512 # ssh_settings_request_password_change property Whether to request a password change when connecting. ## Syntax ```text def get_ssh_settings_request_password_change() -> bool: ... def set_ssh_settings_request_password_change(value: bool) -> None: ... ssh_settings_request_password_change = property(get_ssh_settings_request_password_change, set_ssh_settings_request_password_change) ``` ## Default Value FALSE ## Remarks Whether to request a password change when connecting. # ssh_settings_software_name property The name to be used by the class to identify itself. ## Syntax ```text def get_ssh_settings_software_name() -> str: ... def set_ssh_settings_software_name(value: str) -> None: ... ssh_settings_software_name = property(get_ssh_settings_software_name, set_ssh_settings_software_name) ``` ## Default Value "SecureBlackbox" ## Remarks The name to be used by the component to identify itself. # ssh_settings_trust_all_keys property Enables or disables explicit trust to all server keys. ## Syntax ```text def get_ssh_settings_trust_all_keys() -> bool: ... def set_ssh_settings_trust_all_keys(value: bool) -> None: ... ssh_settings_trust_all_keys = property(get_ssh_settings_trust_all_keys, set_ssh_settings_trust_all_keys) ``` ## Default Value FALSE ## Remarks Enables or disables explicit trust to all server keys. Use with care. # ssh_settings_use_auth_agent property Enables or disables the use of external key agent, such as Putty key agent. ## Syntax ```text def get_ssh_settings_use_auth_agent() -> bool: ... def set_ssh_settings_use_auth_agent(value: bool) -> None: ... ssh_settings_use_auth_agent = property(get_ssh_settings_use_auth_agent, set_ssh_settings_use_auth_agent) ``` ## Default Value FALSE ## Remarks Enables or disables the use of external key agent, such as Putty key agent. # ssh_settings_versions property Specifies enabled SSH protocol versions (1 or 2). ## Syntax ```text def get_ssh_settings_versions() -> int: ... def set_ssh_settings_versions(value: int) -> None: ... ssh_settings_versions = property(get_ssh_settings_versions, set_ssh_settings_versions) ``` ## Default Value 1 ## Remarks Specifies enabled SSH protocol versions (1 or 2). # trusted_keys_file property A file containing the keys of authorized servers. ## Syntax ```text def get_trusted_keys_file() -> str: ... def set_trusted_keys_file(value: str) -> None: ... trusted_keys_file = property(get_trusted_keys_file, set_trusted_keys_file) ``` ## Default Value "" ## Remarks Use this property to provide a path to the 'authorized_keys' file to be used by the client. # upload_block_size property The upload block size in bytes. ## Syntax ```text def get_upload_block_size() -> int: ... def set_upload_block_size(value: int) -> None: ... upload_block_size = property(get_upload_block_size, set_upload_block_size) ``` ## Default Value 32256 ## Remarks Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings ([auto_adjust_transfer_block](#auto_adjust_transfer_block-property)) don't work. # username property The client's username to authenticate to the server. ## Syntax ```text def get_username() -> str: ... def set_username(value: str) -> None: ... username = property(get_username, set_username) ``` ## Default Value "" ## Remarks Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types. # use_utf8 property Enables UTF8 for all string content. ## Syntax ```text def get_use_utf8() -> bool: ... def set_use_utf8(value: bool) -> None: ... use_utf8 = property(get_use_utf8, set_use_utf8) ``` ## Default Value FALSE ## Remarks If *UseUTF8* is true, the class expects all downloaded filenames to be encoded in UTF-8. Set *UseUTF8* to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set. # version property The SFTP version negotiated. ## Syntax ```text def get_version() -> int: ... version = property(get_version, None) ``` ## Default Value 0 ## Remarks Use this property to get the negotiated SFTP version. This property is read-only. # absolute_path method Requests the absolute path for a relative path. ## Syntax ```text def absolute_path(remote_path: str) -> str: ... ``` ## Remarks Use this method to ask the SFTP server to convert a relative path to an absolute. # change_dir method Changes current working directory on the server. ## Syntax ```text def change_dir(remote_dir: str) -> None: ... ``` ## Remarks Changes current working directory on the server to *RemoteDir*. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#sftpclient-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#sftpclient-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method Connects to an SFTP server. ## Syntax ```text def connect(address: str, port: int) -> None: ... ``` ## Remarks Use this method to connect to the SFTP server identified via its *Address* and *Port*. # create_link method Creates a symbolic or hard link to a remote file. ## Syntax ```text def create_link(link_path: str, target_path: str, hard_link: bool) -> None: ... ``` ## Remarks Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the *LinkPath* parameter, and the destination file or directory path via the *TargetPath* parameter. *HardLink* specifies whether the new link should be hard (true) or symbolic (false). # delete_dir method Removes directory from the SFTP server. ## Syntax ```text def delete_dir(remote_dir: str) -> None: ... ``` ## Remarks Use *RemoteDir* to provide a path to the directory to be deleted. # delete_file method Deletes a file from the SFTP server. ## Syntax ```text def delete_file(remote_file: str) -> None: ... ``` ## Remarks Use the *RemoteFile* parameter to specify the name of the file to delete. # delete_files method Deletes a group of files from the SFTP server. ## Syntax ```text def delete_files(remote_path: str, mask: str, case_sensitive: bool, recursive: bool, error_handling: int) -> None: ... ``` ## Remarks Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via *RemotePath* and *Mask* parameters. Use *CaseSensitive* and *Recursive* parameters to tune up the operation. The *ErrorHandling* parameter specifies the error handling tactics. | | | | | --- | --- | --- | | ehStopOnFailure | 0 | Stop on the first failure and throw an exception | | ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list | | ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process | This method is a more efficient way to delete a group of files than deleting them one by one. # dir_exists method Checks if a directory exists on the SFTP server. ## Syntax ```text def dir_exists(remote_dir: str) -> bool: ... ``` ## Remarks *RemoteDir* specifies the name of the remote directory to check for existence. # disconnect method Disconnects from the SFTP server. ## Syntax ```text def disconnect() -> None: ... ``` ## Remarks Call this method to disconnect from the SFTP server. # do_action method Performs an additional action. ## Syntax ```text def do_action(action_id: str, action_params: str) -> str: ... ``` ## Remarks do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # download_bytes method Downloads a file from the server into an array of bytes. ## Syntax ```text def download_bytes(remote_file: str) -> bytes: ... ``` ## Remarks Use this method to download *RemoteFile* into a byte array. # download_file method Downloads a file from the SFTP server. ## Syntax ```text def download_file(remote_file: str, local_file: str) -> None: ... ``` ## Remarks Use this method to download *RemoteFile* into the location specified by *LocalFile*. # download_files method Downloads multiple files from the SFTP server. ## Syntax ```text def download_files(remote_path: str, local_dir: str, recursive: bool, error_handling: int) -> None: ... ``` ## Remarks *RemotePath* contains a file mask or regular expression by which the files are selected for download. *LocalDir* specifies the local folder where the files should be saved. The *Recursive* parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual *RemotePath*, but not its subdirectories, will be downloaded. The *ErrorHandling* parameter specifies the error handling tactics. | | | | | --- | --- | --- | | ehStopOnFailure | 0 | Stop on the first failure and throw an exception | | ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list | | ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process | # execute_ssh_command method Sends an SSH command to the server in the middle of SFTP session. ## Syntax ```text def execute_ssh_command(command: str) -> bytes: ... ``` ## Remarks Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected. This method is suitable for simple commands that do not require interaction with the user. The call returns the command output. # extension_cmd method Sends an extension command to the server. ## Syntax ```text def extension_cmd(extn: str, data_buffer: bytes) -> bytes: ... ``` ## Remarks Use this method to send an extension command to the SFTP server. Provide the extension type via the *Extn* parameter, and the request body via the *DataBuffer* parameter. Upon completion of the command, the method returns the response as received from the server. # file_exists method Checks whether a file exists on the server. ## Syntax ```text def file_exists(remote_file: str) -> bool: ... ``` ## Remarks Use this method to check if a *RemoteFile* exists on the server. # get_current_dir method Returns the current directory on the SFTP server. ## Syntax ```text def get_current_dir() -> str: ... ``` ## Remarks Use this method to retrieve the current directory as stored by the class. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory. # get_file_size method Checks the size of a remote file. ## Syntax ```text def get_file_size(remote_file: str) -> int: ... ``` ## Remarks Returns the size of the *RemoteFile*. # list_dir method Lists the content of the current remote directory. ## Syntax ```text def list_dir(include_files: bool, include_directories: bool) -> str: ... ``` ## Remarks *IncludeFiles* specifies whether file names and symlinks should be included in the results. *IncludeDirectories* specifies whether directory names should be included in the result. Upon receiving the listing, the component will report each entry in it via [on_list_entry](#on_list_entry-event) event. # make_dir method Creates a new directory on the server. ## Syntax ```text def make_dir(remote_dir: str) -> None: ... ``` ## Remarks *RemoteDir* specifies the name of the new directory. # rename_file method Renames a file. ## Syntax ```text def rename_file(source_file: str, dest_file: str) -> None: ... ``` ## Remarks Use this method to rename a remote file. Provide the old and the new name via *SourceFile* and *DestFile* parameters. # request_attributes method Requests attributes of the remote file. ## Syntax ```text def request_attributes(remote_path: str, follow_sym_links: bool) -> str: ... ``` ## Remarks Use this method to request attributes of a remote file. Pass the name of the file via the *RemotePath* parameter, and use *FollowSymLinks* to specify whether symbolic links should be resolved. The method returns the list of attributes as a line of semicolon-separated entries: *Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1*. # reset method Resets the class settings. ## Syntax ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # set_attributes method Sets the attributes upon a remote file. ## Syntax ```text def set_attributes(remote_path: str, attributes: str) -> None: ... ``` ## Remarks Use this method to set the attributes of a remote file. # upload_bytes method Uploads a byte array to the server. ## Syntax ```text def upload_bytes(bytes: bytes, remote_file: str) -> None: ... ``` ## Remarks Use this method to upload *Bytes* or its part to *RemoteFile* on the server. # upload_file method Uploads a file to the server. ## Syntax ```text def upload_file(local_file: str, remote_file: str) -> None: ... ``` ## Remarks Use this method to upload *LocalFile* to the *RemoteFile* location on the server. # upload_files method Uploads multiple files to the server. ## Syntax ```text def upload_files(local_path: str, remote_dir: str, recursive: bool, error_handling: int) -> None: ... ``` ## Remarks Use this property to upload a batch of files to the server. *LocalPath* specifies a wildcard or regular expression by which the local files are picked for uploading. *RemoteDir* specifies the location on the server where these files should be saved. The *Recursive* parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual *LocalPath*, but not its subdirectories, will be uploaded. The *ErrorHandling* parameter specifies one of the pre-defined error handling tactics: | | | | | --- | --- | --- | | ehStopOnFailure | 0 | Stop on the first failure and throw an exception | | ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list | | ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process | # on_auth_attempt event Fires when an authentication attempt is performed. ## Syntax ```text class SFTPClientAuthAttemptEventParams(object): @property def auth_type() -> int: ... # In class SFTPClient: @property def on_auth_attempt() -> Callable[[SFTPClientAuthAttemptEventParams], None]: ... @on_auth_attempt.setter def on_auth_attempt(event_hook: Callable[[SFTPClientAuthAttemptEventParams], None]) -> None: ... ``` ## Remarks This event signals the start of an authentication attempt. The *AuthType* parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another. Supported authentication types: | | | | | --- | --- | --- | | atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. | | atPublicKey | 0x02 | Public key (sometimes called private key) authentication | | atPassword | 0x04 | Password-based authentication | | atHostbased | 0x08 | Hostbased authentication | | atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. | | atGssWithMic | 0x20 | GSS authentication | | atGssKeyex | 0x40 | GSS authentication with key exchange | | atPublicKeyAgent | 0x80 | Public key agent authentication | # on_auth_failed event Fires if an authentication attempt fails. ## Syntax ```text class SFTPClientAuthFailedEventParams(object): @property def auth_type() -> int: ... # In class SFTPClient: @property def on_auth_failed() -> Callable[[SFTPClientAuthFailedEventParams], None]: ... @on_auth_failed.setter def on_auth_failed(event_hook: Callable[[SFTPClientAuthFailedEventParams], None]) -> None: ... ``` ## Remarks This event fires if an authentication attempt fails (for example, if a bad password had been provided). *AuthType* parameter indicates the authentication type. AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the [auth_attempts](#auth_attempts-property) property. This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method. Supported authentication types: | | | | | --- | --- | --- | | atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. | | atPublicKey | 0x02 | Public key (sometimes called private key) authentication | | atPassword | 0x04 | Password-based authentication | | atHostbased | 0x08 | Hostbased authentication | | atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. | | atGssWithMic | 0x20 | GSS authentication | | atGssKeyex | 0x40 | GSS authentication with key exchange | | atPublicKeyAgent | 0x80 | Public key agent authentication | # on_auth_succeeded event Reports a successful authentication. ## Syntax ```text class SFTPClientAuthSucceededEventParams(object): # In class SFTPClient: @property def on_auth_succeeded() -> Callable[[SFTPClientAuthSucceededEventParams], None]: ... @on_auth_succeeded.setter def on_auth_succeeded(event_hook: Callable[[SFTPClientAuthSucceededEventParams], None]) -> None: ... ``` ## Remarks This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol. # on_banner event Reports the receipt of the Welcome message from the server. ## Syntax ```text class SFTPClientBannerEventParams(object): @property def text() -> bytes: ... @property def language() -> bytes: ... # In class SFTPClient: @property def on_banner() -> Callable[[SFTPClientBannerEventParams], None]: ... @on_banner.setter def on_banner(event_hook: Callable[[SFTPClientBannerEventParams], None]) -> None: ... ``` ## Remarks The class fires this event when it receives a welcome message from the server. Use the *Text* parameter to access the encoded message. # on_disconnect event Reports SFTP connection closure. ## Syntax ```text class SFTPClientDisconnectEventParams(object): @property def close_reason() -> int: ... # In class SFTPClient: @property def on_disconnect() -> Callable[[SFTPClientDisconnectEventParams], None]: ... @on_disconnect.setter def on_disconnect(event_hook: Callable[[SFTPClientDisconnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report connection closure. No more SFTP activity could be done after the disconnect. # on_error event Information about errors during SFTP connection. ## Syntax ```text class SFTPClientErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class SFTPClient: @property def on_error() -> Callable[[SFTPClientErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[SFTPClientErrorEventParams], None]) -> None: ... ``` ## Remarks The event is fired in case of exceptional conditions during data transfer. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of error codes please refer to [SFTP](#sftpclient-errors). # on_external_sign event Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax ```text class SFTPClientExternalSignEventParams(object): @property def operation_id() -> str: ... @property def hash_algorithm() -> str: ... @property def pars() -> str: ... @property def data() -> str: ... @property def signed_data() -> str: ... @signed_data.setter def signed_data(value) -> None: ... # In class SFTPClient: @property def on_external_sign() -> Callable[[SFTPClientExternalSignEventParams], None]: ... @on_external_sign.setter def on_external_sign(event_hook: Callable[[SFTPClientExternalSignEventParams], None]) -> None: ... ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # on_file_name_change_needed event Asks the application for a new file name. ## Syntax ```text class SFTPClientFileNameChangeNeededEventParams(object): @property def file_name() -> str: ... @file_name.setter def file_name(value) -> None: ... @property def force() -> bool: ... @force.setter def force(value) -> None: ... # In class SFTPClient: @property def on_file_name_change_needed() -> Callable[[SFTPClientFileNameChangeNeededEventParams], None]: ... @on_file_name_change_needed.setter def on_file_name_change_needed(event_hook: Callable[[SFTPClientFileNameChangeNeededEventParams], None]) -> None: ... ``` ## Remarks The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the *FileName* as required to avoid the conflict, or set *Force* to true to go ahead with the current name (possibly overwriting an existing file). # on_file_operation event Signifies the start of a file transfer operation. ## Syntax ```text class SFTPClientFileOperationEventParams(object): @property def operation() -> int: ... @property def remote_path() -> str: ... @property def local_path() -> str: ... @property def skip() -> bool: ... @skip.setter def skip(value) -> None: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class SFTPClient: @property def on_file_operation() -> Callable[[SFTPClientFileOperationEventParams], None]: ... @on_file_operation.setter def on_file_operation(event_hook: Callable[[SFTPClientFileOperationEventParams], None]) -> None: ... ``` ## Remarks This event is fired each time the class starts an upload or download operation within a multi-file call. *Operation* defines the operation about to start, *RemotePath* specifies the name and path to the remote file, and *LocalPath* specifies the name and path to the local file. If needed, set *Skip* to true to ignore the current file, or *Cancel* to abort the whole batch. Supported operations: | | | | | --- | --- | --- | | cffoDownloadFile | 0 | Download file | | cffoUploadFile | 1 | Upload file | | cffoDeleteFile | 2 | Delete file | | cffoMakeDir | 3 | Make directory | # on_file_operation_result event Signifies the completion of a file transfer operation. ## Syntax ```text class SFTPClientFileOperationResultEventParams(object): @property def operation() -> int: ... @property def remote_path() -> str: ... @property def local_path() -> str: ... @property def error_code() -> int: ... @property def comment() -> str: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class SFTPClient: @property def on_file_operation_result() -> Callable[[SFTPClientFileOperationResultEventParams], None]: ... @on_file_operation_result.setter def on_file_operation_result(event_hook: Callable[[SFTPClientFileOperationResultEventParams], None]) -> None: ... ``` ## Remarks This event is fired each time the class completes a file transfer within a multi-file call. *Operation* defines the operation performed on the file, *RemotePath* specifies the name and path to the remote file, and *LocalPath* specifies the name and path to the local file. *ErrorCode* and *Comment* return the code and textual description of the error, if it was encountered. Set *Cancel* to True to cancel the multi-file operation. Supported operations: | | | | | --- | --- | --- | | cffoDownloadFile | 0 | Download file | | cffoUploadFile | 1 | Upload file | | cffoDeleteFile | 2 | Delete file | | cffoMakeDir | 3 | Make directory | # on_known_key_received event Signals that the server has introduced itself with a known key. ## Syntax ```text class SFTPClientKnownKeyReceivedEventParams(object): @property def algorithm() -> str: ... @property def bits() -> int: ... @property def fingerprint_sha256() -> str: ... # In class SFTPClient: @property def on_known_key_received() -> Callable[[SFTPClientKnownKeyReceivedEventParams], None]: ... @on_known_key_received.setter def on_known_key_received(event_hook: Callable[[SFTPClientKnownKeyReceivedEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to tell the application that the server has introduced itself with a known key from [trusted_keys_file](#trusted_keys_file-property). The details of the key are provided: *Algorithm* and *Bits* specify the key algorithm and the number of bits. *FingerprintSHA256* contains the key's fingerprint. Use server_key to access more key details. # on_list_entry event Reports a directory listing entry to the application. ## Syntax ```text class SFTPClientListEntryEventParams(object): @property def file_name() -> str: ... # In class SFTPClient: @property def on_list_entry() -> Callable[[SFTPClientListEntryEventParams], None]: ... @on_list_entry.setter def on_list_entry(event_hook: Callable[[SFTPClientListEntryEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report a directory listing entry to the application. *FileName* contains the entry name. Use current_list_entry to access the details of the entry. # on_notification event This event notifies the application about an underlying control flow event. ## Syntax ```text class SFTPClientNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class SFTPClient: @property def on_notification() -> Callable[[SFTPClientNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[SFTPClientNotificationEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. # on_password_change_request event Signals that the server requests a password change. ## Syntax ```text class SFTPClientPasswordChangeRequestEventParams(object): @property def prompt() -> str: ... @property def new_password() -> str: ... @new_password.setter def new_password(value) -> None: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class SFTPClient: @property def on_password_change_request() -> Callable[[SFTPClientPasswordChangeRequestEventParams], None]: ... @on_password_change_request.setter def on_password_change_request(event_hook: Callable[[SFTPClientPasswordChangeRequestEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake. # on_private_key_needed event Asks the application for the client's private key. ## Syntax ```text class SFTPClientPrivateKeyNeededEventParams(object): @property def skip() -> bool: ... @skip.setter def skip(value) -> None: ... # In class SFTPClient: @property def on_private_key_needed() -> Callable[[SFTPClientPrivateKeyNeededEventParams], None]: ... @on_private_key_needed.setter def on_private_key_needed(event_hook: Callable[[SFTPClientPrivateKeyNeededEventParams], None]) -> None: ... ``` ## Remarks The class fires this event if the public key provided in key was accepted by the server, but no private key is available for it. Use this event handler to attach the private key to your key. The component will pick the key up and continue the authentication. # on_progress event Fires periodically during the data transfer. ## Syntax ```text class SFTPClientProgressEventParams(object): @property def total() -> int: ... @property def current() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class SFTPClient: @property def on_progress() -> Callable[[SFTPClientProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[SFTPClientProgressEventParams], None]) -> None: ... ``` ## Remarks Use this event to check the progress of an upload or download operation. *Total* indicates the total number of bytes to be transferred; *Current* specifies how much data has been transferred so far, and *Cancel* gives you a chance to cancel the operation. # on_unknown_key_received event Signals that the server has introduced itself with an unknown key. ## Syntax ```text class SFTPClientUnknownKeyReceivedEventParams(object): @property def algorithm() -> str: ... @property def bits() -> int: ... @property def fingerprint_sha256() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SFTPClient: @property def on_unknown_key_received() -> Callable[[SFTPClientUnknownKeyReceivedEventParams], None]: ... @on_unknown_key_received.setter def on_unknown_key_received(event_hook: Callable[[SFTPClientUnknownKeyReceivedEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to tell the application that the server has introduced itself with a key not present in [trusted_keys_file](#trusted_keys_file-property). The details of the key are provided: *Algorithm* and *Bits* specify the key algorithm and the number of bits. *FingerprintSHA256* contains the key's fingerprint. In this event handler, you need to make a decision whether to proceed with the connection. Use *Action* to tell the class what it should do with the key: | | | | | --- | --- | --- | | catAcceptOnce | 1 | Accept the key for the current session only. | | catAcceptPermanently | 2 | Accept the key for the current session and store the key to the trusted keys list. | | catReject | 3 | Reject the key and close the connection. | Note that accepting an unknown and unchecked key may be risky. # SFTPClient Config Settings The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [config](#config-method) method. ### SFTPClient Config Settings **AdjustFileTimes**: Whether file times should be adjusted after upload/download.If this property value is True, file times (creation, access and last modification times) will be adjusted after upload/download operation. **AllAlgorithms**: Returns the list of algorithms enabled in the component.Use this configuration setting to obtain the list of algorithms currently enabled in the component in the *kexinit* format. **ASCIIMode**: Whether ASCII transfer mode is used.When this property is True, ASCII (text) transfer mode is used, otherwise the transfer is performed in binary mode. **AvailableSpace**: Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work.This config property returns the details of the server disk space. The information is provided in the form of semicolon-separated entries: BytesOnDevice, UnusedBytesOnDevice, BytesAvailableToUser, UnusedBytesAvailableToUser, BytesPerAllocationUnit. You can use this property without parameters, or provide a specific mounting point in brackets: AvailableSpace(./path). **CaseConversion**: Whether file names and paths should be case-converted.Defines whether file names are converted (on the destination system) to: lowercase (1), uppercase (2). **CaseSensitive**: Specifies if file paths are case-sensitive.Set this property to True if all file names, paths and file masks should be case-sensitive. **CloseQuietly**: Controls the client's approach to session closure.The quiet closure entails the client shutting down the connection immediately without expecting graceful notifications from the other side. When closing non-quietly, the client will close the connection gradually, starting from the SSH session before proceeding to shutdown-based socket closure. Both options have their pros and cons; choose carefully the option that you want to use going forward. **CommandTimeout**: Specifies the command timeout.Specifies the command timeout (the maximum time to expect the result from the SSH command), in milliseconds. **CompressionAlgorithms**: Returns the list of compression algorithms enabled in the component.Use this configuration setting to get the list of compression algorithms currently enabled in the component, as a respective *kexinit* block line. **CopyMode**: Tunes up the post-transfer action for batch uploads.Use this setting to adjust the post-transfer action for files that are uploaded or downloaded as part of a batch. The following values are supported: - 0 (the default setting) - no post-transfer action. - 1 - delete each file immediately after it has been transferred to the destination system. - 2 - delete all the original files after all the files have been transferred to the destination system. The difference between modes 1 and 2 is about error management. In the latter case, any (and all) files will only be deleted if the entire batch has been transferred successfully. Any transfer error that happens in the middle cancels the deletion. In the former case, each file is deleted right after it has been transferred, independently of the outcome of transfer of other items in the batch. Note that this setting only applies to batch (multi-file_ transfers. It has no effect on single-file transfers. **DefaultTransferBlock**: Specifies the default transfer block size.This setting provides means to adjust the size of the SFTP transfer block (i.e. the size of the content of the write and read packets). It can be used to influence the transfer speed. **DefOutboundBlockSize**: The default outbound block size.Use this property to configure the outbound data block size. **DisablePacketFragmentation**: Enables or disables SSH packet fragmentation.Use this property to enable or disable SSH packet fragmentation. This is one of the settings that is worth a look if encountering unexplained transfer issues. **EarlyIdString**: Enables the proactive approach to SSH handshake.The rule of thumb in the majority of SSH environments is for the server to initiate the handshake with its identification string (and for the client to respond). By setting this property to true you can tell the client to initiate the handshake by sending out the identification string proactively without waiting for the server to send one in. This setting may help in situations where your SSH or SFTP connection fails unexpectedly due to a timeout or network error. **EncryptionAlgorithms**: Returns the list of encryption algorithms enabled in the component.Use this configuration setting to get the list of symmetric encryption algorithms currently enabled in the component, as a respective *kexinit* block line. **ErrorOrigin**: Specifies whether the error is local or remote.Use this property to check where the error took place. **ErrorSeverity**: Specifies whether the error is fatal.Use this property to check whether the error is fatal or not. **FileHash**: Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work.Use this property to request the hash of a remote file. Pass the file name in brackets: FileHash(./path/file.ext). You can adjust the hash algorithm using the HashAlgorithm configuration setting. **HashAlgorithm**: The hash algorithm to use for the protocol operations.Specifies the hash algorithm to use for file protocol operations, such as FileHash. **HomeDir**: Returns a user's home directory. This protocol extension must be supported by the server for this request to work.Use this property to request a specific user's home directory on the server. Provide the username in brackets: HomeDir(user2). **IncomingSpeedLimit**: Specifies incoming speed limit.Use this property to limit the maximum number of bytes per second that client may receive. The value of 0 (zero) means "no limitation". **KeepAlivePeriod**: The inactivity period after which a keep-alive signal will be sent.Use this property to specify tunnel inactivity period (in milliseconds) after which a keep-alive signal will be sent. The default value is 0 (no keep-alive signals). **KexAlgorithms**: Returns the list of key exchange algorithms enabled in the component.Use this configuration setting to get the list of key exchange algorithms currently enabled in the component, as a respective *kexinit* block line. **LocalCharset**: Charset used on the client machine.This property specifies the charset used on the local client computer. **LocalNewLineConvention**: A character string for the end of line (EOL) indication on the local machine.This property contains a character string for the end of line (EOL) indication on the local machine. **MacAlgorithms**: Returns the list of MAC algorithms enabled in the component.Use this configuration setting to get the list of MAC algorithms currently enabled in the component, as a respective *kexinit* block line. **NewLineConvention**: A character string for the end of line (EOL) indication on the server.This property contains a character string for the end of line (EOL) indication used by the server. Usually its value is one of: 0x0d, 0x0d0x0a, 0x0a0x0d, or 0x0a, but it can differ for some servers. **OutgoingSpeedLimit**: Specifies incoming speed limit.Use this property to limit the maximum number of bytes per second that client may send. The value of 0 (zero) means "no limitation". **PreserveExistingFileTimes**: Whether original file times should be restored upon transfer.If the destination file exists and *PreserveExistingFileTimes* option is enabled, the class will remember the file's times before transfer, and restore them after the file has been transferred. The default value is False. **PublicKeyAlgorithms**: Returns the list of public key algorithms enabled in the component.Use this configuration setting to get the list of public key algorithms currently enabled in the component, as a respective *kexinit* block line. **RedirectStdErr**: Whether to redirect output to StdErr.If this property is True, all output will be redirected to StdErr. **RemoteCharset**: Charset used on the server.This property specifies the charset used on the server. **SFTPBufferSize**: The size of internal buffer used for data transfer.Use this property to control the size of the internal buffers used for data transfer. **SFTPServerExecutableLocations**: Location of the SFTP server executable.Specifies the location of the SFTP server executable. **SocketRecvBufferSize**: The inbound socket buffer size.Use this property to adjust the size of the inbound socket buffer. **SocketSendBufferSize**: The outbound socket buffer size.Use this property to adjust the size of the outbound socket buffer. **StatVFS**: Returns VFS details. This protocol extension must be supported by the server for this request to work.This config property returns the VFS details of the server file system. The information is provided in the form of semicolon-separated entries. You can use this property without parameters, or provide a specific mounting point in brackets: StatVFS(./). **StdErrData**: The buffer for writing StdErr data.This property represents a buffer where StdErr data is written by the class. **SuppressAuxTransferOps**: TBD.TBD **TempFolder**: Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.Use this property to request a path to the temporary directory maintained by the server. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **TreatZeroSizeAsUndefined**: Whether zero size returned by STAT should be considered as undefined.This property specifies if the size of zero returned by the STAT command for a particular file should be considered as undefined. It makes sense to set this property to True, because some operating systems (e.g. Unix-based) return zero size for the files of certain type. For instance, most of the files contained in the /proc directory are reported as 0-sized, while actually not being empty. **TryPasswordAuth**: Specifies whether the component should attempt the password-based authentication if no password is set.If the Password property is not set, the component disables the password-based authentication. Set this property to true to make it try the empty password instead. **UseStrictKeyExchange**: Specifies how strict key exchange is supported.This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm *kex-strict-c-v00@openssh.com* for client classes and *kex-strict-s-v00@openssh.com* for server classes in the list of supported key exchange algorithms. Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are: | | | | --- | --- | | 0 | Disabled. Strict key exchange is not supported in the class. | | 1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. | | 2 | Enabled, but 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 only continue if the selected encryption and 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. | **UseTruncateFlagOnUpload**: whether to use the 'truncate' flag on file upload.If this property is True, the existing files are opened truncated on upload, otherwise new files are created. The default value is True. **UseUTF8OnV3**: Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.If this property is True, UTF-8 encoding will be applied to file names for SFTP protocol versions 3 and lower. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # SFTPClient Errors ### SFTPClient Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 31457281 | Unsupported file operation ([SB_ERROR_SFTP_UNSUPPORTED_FILE_OPERATION](constants.md#const_SBERRORSFTPUNSUPPORTEDFILEOPERATION)) | | 31457282 | Invalid authentication type ([SB_ERROR_SFTP_INVALID_AUTH_TYPE](constants.md#const_SBERRORSFTPINVALIDAUTHTYPE)) |