SFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class provides client-side functionality for SFTP (Secure File Transfer Protocol).

Syntax

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 and password. 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 property. When a client receives a server key, it reports it to your code via its on_known_key_received or on_unknown_key_received event, depending on whether the key was found in the trusted list. If you leave trusted_keys_file empty, SFTPClient will only be able to fire the on_unknown_key_received 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_failed, and on_auth_succeeded events to be notified about the client authentication progress.
  • When you are ready to connect, call connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: on_unknown_key_received (or on_known_key_received), and then one or more on_auth_attempt, on_auth_failed and on_auth_succeeded.
  • Upon completion of the connect method, the component is ready for file operations. Use download_file, upload_file, list_dir, delete_file and other file transfer methods to work with the server file system.
  • When you are done with your work, call disconnect 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:

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_attemptsSpecifies the number of SSH authentication attempts.
auto_adjust_transfer_blockSpecifies whether to adjust the send and receive buffer sizes automatically.
connectedIndicates if the client is connected to the SFTP server.
conn_info_client_key_algorithmSpecifies the client's key algorithm.
conn_info_client_key_bitsSpecifies the length of the client's key.
conn_info_client_key_fingerprintThe fingerprint (hash value) of the client's public key.
conn_info_close_reasonContains the line sent by the server just before closing the connection.
conn_info_compression_algorithm_inboundCompression algorithm for the incoming traffic.
conn_info_compression_algorithm_outboundCompression algorithm for the outgoing traffic.
conn_info_encryption_algorithm_inboundEncryption algorithm for the incoming traffic.
conn_info_encryption_algorithm_outboundEncryption algorithm for the outgoing traffic.
conn_info_inbound_encryption_key_bitsSpecifies the length of the key used to encrypt the incoming traffic.
conn_info_kex_algorithmThe key exchange algorithm used during the SSH handshake.
conn_info_kex_bitsThe number of bits used by the key exchange algorithm.
conn_info_kex_linesThe contents of the received KexInit packet.
conn_info_mac_algorithm_inboundMAC algorithm used for the incoming connection.
conn_info_mac_algorithm_outboundMAC algorithm used for outbound connection.
conn_info_outbound_encryption_key_bitsSpecifies the length of the key used to encrypt the outgoing traffic.
conn_info_public_key_algorithmSpecifies the public key algorithm which was used during the SSH handshake.
conn_info_server_key_bitsSpecifies the number of bits in the server's key.
conn_info_server_key_fingerprintThe fingerprint (hash value) of the server's public key.
conn_info_server_software_nameReturns the name of the SSH software running on the server side.
conn_info_total_bytes_receivedReturns the total number of bytes received over this connection.
conn_info_total_bytes_sentReturns the total number of bytes sent over this connection.
conn_info_versionSpecifies SSH protocol version.
curr_list_entry_a_timeContains the last access time for this file, in UTC.
curr_list_entry_c_timeContains this file's creation time, in UTC.
curr_list_entry_directorySpecifies whether this entry is a directory.
curr_list_entry_file_typeSpecifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .
curr_list_entry_group_executeControls file execution permission for the group users.
curr_list_entry_group_readControls file read permission for the group users.
curr_list_entry_group_writeControls file write permission for the group users.
curr_list_entry_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
curr_list_entry_long_nameContains the long name of the file (human-readable, ftp-like).
curr_list_entry_m_timeSpecifies the last modification time, in UTC.
curr_list_entry_nameSpecifies the file name.
curr_list_entry_other_executeControls file execution permission for other users (users that are neither owners, nor belong to the same group).
curr_list_entry_other_readControls file read permission for other users (users that are neither owners, nor belong to the same group).
curr_list_entry_other_writeControls file write permission for other users (users that are neither owners, nor belong to the same group).
curr_list_entry_ownerSpecifies the owner of the file/directory.
curr_list_entry_pathContains the full path to the file.
curr_list_entry_sizeThe size of the file in bytes.
curr_list_entry_user_executeControls file execution permission for the file owner.
curr_list_entry_user_readControls file read permission for the file owner.
curr_list_entry_user_writeControls file write permission for the file owner.
download_block_sizeThe download block size in bytes.
external_crypto_async_document_idSpecifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
external_crypto_custom_paramsCustom parameters to be passed to the signing service (uninterpreted).
external_crypto_dataAdditional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculationSpecifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithmSpecifies the request's signature hash algorithm.
external_crypto_key_idThe ID of the pre-shared key used for DC request authentication.
external_crypto_key_secretThe pre-shared key used for DC request authentication.
external_crypto_methodSpecifies the asynchronous signing method.
external_crypto_modeSpecifies the external cryptography mode.
external_crypto_public_key_algorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
fips_modeReserved.
force_compressionEnforces compression for the SSH layer.
key_fingerprint_sha1Contains the SHA-1 fingerprint (hash) of the key.
key_fingerprint_sha256Contains the SHA-256 fingerprint (hash) of the key.
key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
max_sftp_versionHigher SFTP version to support.
min_sftp_versionLower SFTP version to support.
passwordSpecifies user's authentication password.
pipeline_lengthThe number of parallelized transfer requests.
proxy_addressThe IP address of the proxy server.
proxy_authenticationThe authentication type used by the proxy server.
proxy_passwordThe password to authenticate to the proxy server.
proxy_portThe port on the proxy server to connect to.
proxy_proxy_typeThe type of the proxy server.
proxy_request_headersContains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_bodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6Specifies whether IPv6 should be used when connecting through the proxy.
proxy_use_proxyEnables or disables proxy-driven connection.
proxy_usernameSpecifies the username credential for proxy authentication.
server_key_algorithmSpecifies the key algorithm.
server_key_bitsThe number of bits in the key: the more the better, 2048 or 4096 are typical values.
server_key_commentThe comment for the public key.
server_key_curveSpecifies the elliptical curve when EC cryptography is used.
server_key_dssgThe G (Generator) parameter of the DSS signature key.
server_key_dsspThe P (Prime) parameter of the DSS signature key.
server_key_dssqThe Q (Prime Factor) parameter of the DSS signature key.
server_key_dssxThe X (Private key) parameter of the DSS signature key.
server_key_dssyThe Y (Public key) parameter of the DSS signature key.
server_key_eccdThe value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.
server_key_eccqxThe value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.
server_key_eccqyThe value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.
server_key_ed_privateThe value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
server_key_ed_publicThe value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
server_key_fingerprint_md5Contains the MD5 fingerprint (hash) of the key.
server_key_fingerprint_sha1Contains the SHA-1 fingerprint (hash) of the key.
server_key_fingerprint_sha256Contains the SHA-256 fingerprint (hash) of the key.
server_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
server_key_is_extractableWhether the key is extractable (e.
server_key_is_privateWhether this key is a private key or not.
server_key_is_publicWhether this key is a public key or not.
server_key_kdf_roundsReturns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
server_key_kdf_saltThe salt value used by the Key Derivation Function (KDF) to generate this key.
server_key_key_formatSpecifies the format in which the key is stored.
server_key_key_protection_algorithmSpecifies the key protection algorithm.
server_key_rsa_exponentReturns the e parameter (public exponent) of the RSA key.
server_key_rsaiqmpReturns the iqmp parameter of the RSA key.
server_key_rsa_modulusReturns the m parameter (public modulus) of the RSA key.
server_key_rsapReturns the p parameter (first factor of the common modulus n) of the RSA key.
server_key_rsa_private_exponentReturns the d parameter (private exponent) of the RSA key.
server_key_rsaqReturns the q parameter (second factor of the common modulus n) of the RSA key.
server_key_subjectSpecifies the public key owner (subject).
socket_dns_modeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
socket_dns_portSpecifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeoutThe timeout (in milliseconds) for each DNS query.
socket_dns_serversThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeoutThe timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limitThe maximum number of bytes to read from the socket, per second.
socket_local_addressThe local network interface to bind the socket to.
socket_local_portThe local port number to bind the socket to.
socket_outgoing_speed_limitThe maximum number of bytes to write to the socket, per second.
socket_timeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6Enables or disables IP protocol version 6.
ssh_settings_auto_adjust_ciphersWhether 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_configurationAllows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
ssh_settings_compression_algorithmsA list of session compression algorithms separated with commas or semicolons.
ssh_settings_compression_levelPossible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).
ssh_settings_default_window_sizeThe 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_algorithmsA list of session encryption algorithms separated with commas or semicolons.
ssh_settings_force_compressionWhether the SSH client should explicitly request compression.
ssh_settings_gss_auth_typesA comma-separated list of authentication types.
ssh_settings_gss_delegate_credsSwitches credential delegation on or off.
ssh_settings_gss_hostnameThe GSS host name, in form of a FQDN (e.
ssh_settings_gss_libA path to the GSS-API library (DLL or SO).
ssh_settings_gss_mechanismsA comma-separated list of GSS mechanisms to use.
ssh_settings_gss_protocolsA comma-separated list of SSPI protocols.
ssh_settings_handshake_timeoutSpecifies the maximal time for the SSH handshake to proceed, in seconds.
ssh_settings_kex_algorithmsA list of key exchange algorithms separated with commas or semicolons.
ssh_settings_mac_algorithmsA list of MAC (for message authentication code ) algorithms separated with commas or semicolons.
ssh_settings_max_ssh_packet_sizeSpecifies the maximum length of one SSH packet in bytes.
ssh_settings_min_window_sizeSpecifies the minimal internal window size.
ssh_settings_obfuscate_handshakeEnables or disables handshake obfuscation.
ssh_settings_obfuscation_passwordSpecifies the password used to encrypt the handshake when ObfuscateHandshake is set.
ssh_settings_public_key_algorithmsA list of public key algorithms separated with commas or semicolons.
ssh_settings_request_password_changeWhether to request a password change when connecting.
ssh_settings_software_nameThe name to be used by the class to identify itself.
ssh_settings_trust_all_keysEnables or disables explicit trust to all server keys.
ssh_settings_use_auth_agentEnables or disables the use of external key agent, such as Putty key agent.
ssh_settings_versionsSpecifies enabled SSH protocol versions (1 or 2).
trusted_keys_fileA file containing the keys of authorized servers.
upload_block_sizeThe upload block size in bytes.
usernameThe client's username to authenticate to the server.
use_utf8Enables UTF8 for all string content.
versionThe 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_pathRequests the absolute path for a relative path.
change_dirChanges current working directory on the server.
configSets or retrieves a configuration setting.
connectConnects to an SFTP server.
create_linkCreates a symbolic or hard link to a remote file.
delete_dirRemoves directory from the SFTP server.
delete_fileDeletes a file from the SFTP server.
delete_filesDeletes a group of files from the SFTP server.
dir_existsChecks if a directory exists on the SFTP server.
disconnectDisconnects from the SFTP server.
do_actionPerforms an additional action.
download_bytesDownloads a file from the server into an array of bytes.
download_fileDownloads a file from the SFTP server.
download_filesDownloads multiple files from the SFTP server.
execute_ssh_commandSends an SSH command to the server in the middle of SFTP session.
extension_cmdSends an extension command to the server.
file_existsChecks whether a file exists on the server.
get_current_dirReturns the current directory on the SFTP server.
get_file_sizeChecks the size of a remote file.
list_dirLists the content of the current remote directory.
make_dirCreates a new directory on the server.
rename_fileRenames a file.
request_attributesRequests attributes of the remote file.
set_attributesSets the attributes upon a remote file.
upload_bytesUploads a byte array to the server.
upload_fileUploads a file to the server.
upload_filesUploads 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_attemptFires when an authentication attempt is performed.
on_auth_failedFires if an authentication attempt fails.
on_auth_succeededReports a successful authentication.
on_bannerReports the receipt of the Welcome message from the server.
on_disconnectReports SFTP connection closure.
on_errorInformation about errors during SFTP connection.
on_external_signHandles remote or external signing initiated by the SignExternal method or other source.
on_file_operationSignifies the start of a file transfer operation.
on_file_operation_resultSignifies the completion of a file transfer operation.
on_known_key_receivedSignals that the server has introduced itself with a known key.
on_list_entryReports a directory listing entry to the application.
on_notificationThis event notifies the application about an underlying control flow event.
on_password_change_requestSignals that the server requests a password change.
on_private_key_neededAsks the application for the client's private key.
on_progressFires periodically during the data transfer.
on_unknown_key_receivedSignals 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.

AdjustFileTimesWhether file times should be adjusted after upload/download.
ASCIIModeWhether ASCII transfer mode is used.
AvailableSpaceReturns details of server disk space availability. This protocol extension must be supported by the server for this request to work.
CaseConversionWhether case conversion must be applied to file names as they are downloaded.
CaseSensitiveSpecifies if file paths are case-sensitive.
CopyModeDefines what to do with each successfully copied file.
DefOutboundBlockSizeThe default outbound block size.
DisablePacketFragmentationEnables or disables SSH packet fragmentation.
ErrorOriginSpecifies whether the error is local or remote.
ErrorSeveritySpecifies whether the error is fatal.
FileHashReturns the hash of the specified file. This protocol extension must be supported by the server for this request to work.
HashAlgorithmThe hash algorithm to use for the protocol operations.
HomeDirReturns a user's home directory. This protocol extension must be supported by the server for this request to work.
IncomingSpeedLimitSpecifies incoming speed limit.
KeepAlivePeriodThe inactivity period after which a keep-alive signal will be sent.
LocalCharsetCharset used on the client machine.
LocalNewLineConventionA character string for the end of line (EOL) indication on the local machine.
ModeThe file open mode to use.
NewLineConventionA character string for the end of line (EOL) indication on the server.
OutgoingSpeedLimitSpecifies incoming speed limit.
PreserveExistingFileTimesWhether original file times should be restored upon transfer.
RecursiveWhether subdirectories should also be scanned for matching files.
RedirectStdErrWhether to redirect output to StdErr.
RemoteCharsetCharset used on the server.
SFTPBufferSizeThe size of internal buffer used for data transfer.
SFTPServerExecutableLocationsLocation of the SFTP server executable.
StatVFSReturns VFS details. This protocol extension must be supported by the server for this request to work.
StdErrDataThe buffer for writing StdErr data.
TempFolderReturns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.
TempPathLocation where the temporary files are stored.
TreatZeroSizeAsUndefinedWhether zero size returned by STAT should be considered as undefined.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
UseTruncateFlagOnUploadwhether to use the 'truncate' flag on file upload.
UseUTF8OnV3Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

auth_attempts Property

Specifies the number of SSH authentication attempts.

Syntax

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 event is fired for every failed attempt.

auto_adjust_transfer_block Property

Specifies whether to adjust the send and receive buffer sizes automatically.

Syntax

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, upload_block_size, and pipeline_length properties to adjust the transfer settings manually.

connected Property

Indicates if the client is connected to the SFTP server.

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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_server_key_bits Property

Specifies the number of bits in the server's key.

Syntax

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

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_server_software_name Property

Returns the name of the SSH software running on the server side.

Syntax

def get_conn_info_server_software_name() -> str: ...

conn_info_server_software_name = property(get_conn_info_server_software_name, None)

Default Value

""

Remarks

Returns the name of the SSH software running on the server side.

This property is read-only.

conn_info_total_bytes_received Property

Returns the total number of bytes received over this connection.

Syntax

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

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

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_a_time Property

Contains the last access time for this file, in UTC.

Syntax

def get_curr_list_entry_a_time() -> str: ...

curr_list_entry_a_time = property(get_curr_list_entry_a_time, None)

Default Value

""

Remarks

Contains the last access time for this file, in UTC.

This property is read-only.

curr_list_entry_c_time Property

Contains this file's creation time, in UTC.

Syntax

def get_curr_list_entry_c_time() -> str: ...

curr_list_entry_c_time = property(get_curr_list_entry_c_time, None)

Default Value

""

Remarks

Contains this file's creation time, in UTC.

This property is read-only.

curr_list_entry_directory Property

Specifies whether this entry is a directory.

Syntax

def get_curr_list_entry_directory() -> bool: ...

curr_list_entry_directory = property(get_curr_list_entry_directory, None)

Default Value

FALSE

Remarks

Specifies whether this entry is a directory.

This property is read-only.

curr_list_entry_file_type Property

Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .

Syntax

def get_curr_list_entry_file_type() -> int: ...

curr_list_entry_file_type = property(get_curr_list_entry_file_type, None)

Default Value

4

Remarks

Specifies the type of this entry, one of the following:

cftFile0
cftDirectory1
cftSymblink2
cftSpecial3
cftUnknown4
cftSocket5
cftCharDevice6
cftBlockDevice7
cftFIFO8

This property is read-only.

curr_list_entry_group_execute Property

Controls file execution permission for the group users.

Syntax

def get_curr_list_entry_group_execute() -> bool: ...

curr_list_entry_group_execute = property(get_curr_list_entry_group_execute, None)

Default Value

FALSE

Remarks

Controls file execution permission for the group users.

This property is read-only.

curr_list_entry_group_read Property

Controls file read permission for the group users.

Syntax

def get_curr_list_entry_group_read() -> bool: ...

curr_list_entry_group_read = property(get_curr_list_entry_group_read, None)

Default Value

FALSE

Remarks

Controls file read permission for the group users.

This property is read-only.

curr_list_entry_group_write Property

Controls file write permission for the group users.

Syntax

def get_curr_list_entry_group_write() -> bool: ...

curr_list_entry_group_write = property(get_curr_list_entry_group_write, None)

Default Value

FALSE

Remarks

Controls file write permission for the group users.

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

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only.

curr_list_entry_long_name Property

Contains the long name of the file (human-readable, ftp-like).

Syntax

def get_curr_list_entry_long_name() -> str: ...

curr_list_entry_long_name = property(get_curr_list_entry_long_name, None)

Default Value

""

Remarks

Contains the long name of the file (human-readable, ftp-like).

This property is read-only.

curr_list_entry_m_time Property

Specifies the last modification time, in UTC.

Syntax

def get_curr_list_entry_m_time() -> str: ...

curr_list_entry_m_time = property(get_curr_list_entry_m_time, None)

Default Value

""

Remarks

Specifies the last modification time, in UTC.

This property is read-only.

curr_list_entry_name Property

Specifies the file name.

Syntax

def get_curr_list_entry_name() -> str: ...

curr_list_entry_name = property(get_curr_list_entry_name, None)

Default Value

""

Remarks

Specifies the file name.

This property is read-only.

curr_list_entry_other_execute Property

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

Syntax

def get_curr_list_entry_other_execute() -> bool: ...

curr_list_entry_other_execute = property(get_curr_list_entry_other_execute, None)

Default Value

FALSE

Remarks

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

This property is read-only.

curr_list_entry_other_read Property

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

Syntax

def get_curr_list_entry_other_read() -> bool: ...

curr_list_entry_other_read = property(get_curr_list_entry_other_read, None)

Default Value

FALSE

Remarks

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

This property is read-only.

curr_list_entry_other_write Property

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

Syntax

def get_curr_list_entry_other_write() -> bool: ...

curr_list_entry_other_write = property(get_curr_list_entry_other_write, None)

Default Value

FALSE

Remarks

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

This property is read-only.

curr_list_entry_owner Property

Specifies the owner of the file/directory.

Syntax

def get_curr_list_entry_owner() -> str: ...

curr_list_entry_owner = property(get_curr_list_entry_owner, None)

Default Value

""

Remarks

Specifies the owner of the file/directory.

This property is read-only.

curr_list_entry_path Property

Contains the full path to the file.

Syntax

def get_curr_list_entry_path() -> str: ...

curr_list_entry_path = property(get_curr_list_entry_path, None)

Default Value

""

Remarks

Contains the full path to the file.

This property is read-only.

curr_list_entry_size Property

The size of the file in bytes.

Syntax

def get_curr_list_entry_size() -> int: ...

curr_list_entry_size = property(get_curr_list_entry_size, None)

Default Value

0

Remarks

The size of the file in bytes.

This property is read-only.

curr_list_entry_user_execute Property

Controls file execution permission for the file owner.

Syntax

def get_curr_list_entry_user_execute() -> bool: ...

curr_list_entry_user_execute = property(get_curr_list_entry_user_execute, None)

Default Value

FALSE

Remarks

Controls file execution permission for the file owner.

This property is read-only.

curr_list_entry_user_read Property

Controls file read permission for the file owner.

Syntax

def get_curr_list_entry_user_read() -> bool: ...

curr_list_entry_user_read = property(get_curr_list_entry_user_read, None)

Default Value

FALSE

Remarks

Controls file read permission for the file owner.

This property is read-only.

curr_list_entry_user_write Property

Controls file write permission for the file owner.

Syntax

def get_curr_list_entry_user_write() -> bool: ...

curr_list_entry_user_write = property(get_curr_list_entry_user_write, None)

Default Value

FALSE

Remarks

Controls file write permission for the file owner.

This property is read-only.

download_block_size Property

The download block size in bytes.

Syntax

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) don't work.

external_crypto_async_document_id Property

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

external_crypto_custom_params Property

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

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

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

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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

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_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

external_crypto_key_id Property

The ID of the pre-shared key used for DC request authentication.

Syntax

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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

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

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

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)

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

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)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

external_crypto_public_key_algorithm Property

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

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 public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

fips_mode Property

Reserved.

Syntax

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

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

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

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

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

max_sftp_version Property

Higher SFTP version to support.

Syntax

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 properties control the range of SFTP protocol versions supported by this client.

min_sftp_version Property

Lower SFTP version to support.

Syntax

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

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

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) don't work.

proxy_address Property

The IP address of the proxy server.

Syntax

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

def get_proxy_authentication() -> int: ...
def set_proxy_authentication(value: int) -> None: ...

proxy_authentication = property(get_proxy_authentication, set_proxy_authentication)

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

proxy_password Property

The password to authenticate to the proxy server.

Syntax

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

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_proxy_type Property

The type of the proxy server.

Syntax

def get_proxy_proxy_type() -> int: ...
def set_proxy_proxy_type(value: int) -> None: ...

proxy_proxy_type = property(get_proxy_proxy_type, set_proxy_proxy_type)

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

proxy_request_headers Property

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

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

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

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

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_use_proxy Property

Enables or disables proxy-driven connection.

Syntax

def get_proxy_use_proxy() -> bool: ...
def set_proxy_use_proxy(value: bool) -> None: ...

proxy_use_proxy = property(get_proxy_use_proxy, set_proxy_use_proxy)

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

proxy_username Property

Specifies the username credential for proxy authentication.

Syntax

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

def get_server_key_algorithm() -> str: ...

server_key_algorithm = property(get_server_key_algorithm, None)

Default Value

""

Remarks

Specifies the key algorithm.

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

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

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

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.

This property is read-only.

server_key_dssg Property

The G (Generator) parameter of the DSS signature key.

Syntax

def get_server_key_dssg() -> bytes: ...

server_key_dssg = property(get_server_key_dssg, None)

Remarks

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

This property is read-only.

server_key_dssp Property

The P (Prime) parameter of the DSS signature key.

Syntax

def get_server_key_dssp() -> bytes: ...

server_key_dssp = property(get_server_key_dssp, None)

Remarks

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

This property is read-only.

server_key_dssq Property

The Q (Prime Factor) parameter of the DSS signature key.

Syntax

def get_server_key_dssq() -> bytes: ...

server_key_dssq = property(get_server_key_dssq, None)

Remarks

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

This property is read-only.

server_key_dssx Property

The X (Private key) parameter of the DSS signature key.

Syntax

def get_server_key_dssx() -> bytes: ...

server_key_dssx = property(get_server_key_dssx, None)

Remarks

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

This property is read-only.

server_key_dssy Property

The Y (Public key) parameter of the DSS signature key.

Syntax

def get_server_key_dssy() -> bytes: ...

server_key_dssy = property(get_server_key_dssy, None)

Remarks

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

This property is read-only.

server_key_eccd Property

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.

Syntax

def get_server_key_eccd() -> bytes: ...

server_key_eccd = property(get_server_key_eccd, None)

Remarks

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

This property is read-only.

server_key_eccqx Property

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

def get_server_key_eccqx() -> bytes: ...

server_key_eccqx = property(get_server_key_eccqx, None)

Remarks

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

This property is read-only.

server_key_eccqy Property

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

def get_server_key_eccqy() -> bytes: ...

server_key_eccqy = property(get_server_key_eccqy, None)

Remarks

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

This property is read-only.

server_key_ed_private Property

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

def get_server_key_ed_private() -> bytes: ...

server_key_ed_private = property(get_server_key_ed_private, None)

Remarks

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

This property is read-only.

server_key_ed_public Property

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

def get_server_key_ed_public() -> bytes: ...

server_key_ed_public = property(get_server_key_ed_public, None)

Remarks

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

This property is read-only.

server_key_fingerprint_md5 Property

Contains the MD5 fingerprint (hash) of the key.

Syntax

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

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

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

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only.

server_key_is_extractable Property

Whether the key is extractable (e.

Syntax

def get_server_key_is_extractable() -> bool: ...

server_key_is_extractable = property(get_server_key_is_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_is_private Property

Whether this key is a private key or not.

Syntax

def get_server_key_is_private() -> bool: ...

server_key_is_private = property(get_server_key_is_private, None)

Default Value

FALSE

Remarks

Whether this key is a private key or not.

This property is read-only.

server_key_is_public Property

Whether this key is a public key or not.

Syntax

def get_server_key_is_public() -> bool: ...

server_key_is_public = property(get_server_key_is_public, None)

Default Value

FALSE

Remarks

Whether this key is a public key or not.

This property is read-only.

server_key_kdf_rounds Property

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

Syntax

def get_server_key_kdf_rounds() -> int: ...

server_key_kdf_rounds = property(get_server_key_kdf_rounds, None)

Default Value

0

Remarks

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

This property is read-only.

server_key_kdf_salt Property

The salt value used by the Key Derivation Function (KDF) to generate this key.

Syntax

def get_server_key_kdf_salt() -> bytes: ...

server_key_kdf_salt = property(get_server_key_kdf_salt, None)

Remarks

The salt value used by the Key Derivation Function (KDF) to generate this key.

This property is read-only.

server_key_key_format Property

Specifies the format in which the key is stored.

Syntax

def get_server_key_key_format() -> int: ...

server_key_key_format = property(get_server_key_key_format, None)

Default Value

0

Remarks

Specifies the format in which the key is stored.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88
ckfPuTTY39

This property is read-only.

server_key_key_protection_algorithm Property

Specifies the key protection algorithm.

Syntax

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_rsa_exponent Property

Returns the e parameter (public exponent) of the RSA key.

Syntax

def get_server_key_rsa_exponent() -> bytes: ...

server_key_rsa_exponent = property(get_server_key_rsa_exponent, None)

Remarks

Returns the e parameter (public exponent) of the RSA key.

This property is read-only.

server_key_rsaiqmp Property

Returns the iqmp parameter of the RSA key.

Syntax

def get_server_key_rsaiqmp() -> bytes: ...

server_key_rsaiqmp = property(get_server_key_rsaiqmp, None)

Remarks

Returns the iqmp parameter of the RSA key.

This property is read-only.

server_key_rsa_modulus Property

Returns the m parameter (public modulus) of the RSA key.

Syntax

def get_server_key_rsa_modulus() -> bytes: ...

server_key_rsa_modulus = property(get_server_key_rsa_modulus, None)

Remarks

Returns the m parameter (public modulus) of the RSA key.

This property is read-only.

server_key_rsap Property

Returns the p parameter (first factor of the common modulus n) of the RSA key.

Syntax

def get_server_key_rsap() -> bytes: ...

server_key_rsap = property(get_server_key_rsap, None)

Remarks

Returns the p parameter (first factor of the common modulus n) of the RSA key.

This property is read-only.

server_key_rsa_private_exponent Property

Returns the d parameter (private exponent) of the RSA key.

Syntax

def get_server_key_rsa_private_exponent() -> bytes: ...

server_key_rsa_private_exponent = property(get_server_key_rsa_private_exponent, None)

Remarks

Returns the d parameter (private exponent) of the RSA key.

This property is read-only.

server_key_rsaq Property

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Syntax

def get_server_key_rsaq() -> bytes: ...

server_key_rsaq = property(get_server_key_rsaq, None)

Remarks

Returns the q parameter (second factor of the common modulus n) of the RSA key.

This property is read-only.

server_key_subject Property

Specifies the public key owner (subject).

Syntax

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

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)

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

socket_dns_port Property

Specifies the port number to be used for sending queries to the DNS server.

Syntax

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

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 the infinite timeout.

socket_dns_servers Property

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

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

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 the infinite timeout.

socket_incoming_speed_limit Property

The maximum number of bytes to read from the socket, per second.

Syntax

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

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

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

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

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

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

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

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)

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

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

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

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

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

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_gss_auth_types Property

A comma-separated list of authentication types.

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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) don't work.

username Property

The client's username to authenticate to the server.

Syntax

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

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

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

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

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

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

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

connect Method

Connects to an SFTP server.

Syntax

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

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 destinating 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

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

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

def delete_files(remote_path: str, mask: str, case_sensitive: bool, recursive: bool) -> 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.

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

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

def disconnect() -> None: ...

Remarks

Call this method to disconnect from the SFTP server.

do_action Method

Performs an additional action.

Syntax

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 insencitive) 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;....

download_bytes Method

Downloads a file from the server into an array of bytes.

Syntax

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

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

def download_files(remote_path: str, local_dir: str) -> 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.

execute_ssh_command Method

Sends an SSH command to the server in the middle of SFTP session.

Syntax

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

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

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

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

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

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

make_dir Method

Creates a new directory on the server.

Syntax

def make_dir(remote_dir: str) -> None: ...

Remarks

RemoteDir specifies the name of the new directory.

rename_file Method

Renames a file.

Syntax

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

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.

set_attributes Method

Sets the attributes upon a remote file.

Syntax

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

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

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

def upload_files(local_path: str, remote_dir: str) -> 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.

on_auth_attempt Event

Fires when an authentication attempt is performed.

Syntax

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:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

on_auth_failed Event

Fires if an authentication attempt fails.

Syntax

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

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

on_auth_succeeded Event

Reports a successful authentication.

Syntax

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

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

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

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.

on_external_sign Event

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

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 component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .NET RSACryptoServiceProvider class may look like the following: 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_operation Event

Signifies the start of a file transfer operation.

Syntax

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:

csfoDownloadFile0Download file

csfoUploadFile1Upload file

csfoDeleteFile2Delete file

csfoMakeDir3Make directory

on_file_operation_result Event

Signifies the completion of a file transfer operation.

Syntax

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:

csfoDownloadFile0Download file

csfoUploadFile1Upload file

csfoDeleteFile2Delete file

csfoMakeDir3Make directory

on_known_key_received Event

Signals that the server has introduced itself with a known key.

Syntax

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.

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

class SFTPClientListEntryEventParams(object):
  @property
  def filename() -> 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

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 component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, 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

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

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

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

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.

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:

catAcceptOnce1Accept the key for the current session only.
catAcceptPermanently2Accept the key for the current session and store the key to the trusted keys list.
catReject3Reject 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 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.

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 case conversion must be applied to file names as they are downloaded.

You can choose to: convert file names to upper case, convert file names to lower case, or to keep them as they are.

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.

CopyMode:   Defines what to do with each successfully copied file.

You could choose to: simply copy the file, delete each file's origin right after that file has been copied, or delete all original files only after all files have been copied.

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.

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

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.

Mode:   The file open mode to use.

This property allows to provide a custom file upload mode.

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.

Recursive:   Whether subdirectories should also be scanned for matching files.

Set this property to True to indicate that subdirectories should also be scanned for matching files

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.

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.

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:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

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.

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:

0Disabled. 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.
2Enabled, 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.
3Required. 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

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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.

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

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.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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 devided 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 chached 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).

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.

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.

SFTPClient Errors

SFTPClient Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION)