SSHClient Class

Properties Methods Events Config Settings Errors

The SSHClient class provides client-side SSH protocol functionality.

Syntax

class secureblackbox.SSHClient

Remarks

Use SSHClient to establish terminal-like connections to remote systems and run commands remotely. The component supports most of third-party implementations out there, and is capable of working in "shell" and "command" modes.

Start with assigning your sign-in credentials to username and password properties. Where public key authentication is to be used, assign your private authentication key to key property (remember to set username in this case too). Subscribe to events to be notified of the session progress. on_auth_failed, on_auth_succeeded, and on_connect are among those particularly useful.

Special attention should be paid to setting up the server key trust. Class only allows connections to servers whose public keys are recognized as trusted, much like any other SSH clients do. Assign a path to the file containing the list of trusted keys to trusted_keys_file property. If you don't have such file, or if you would like to make trust decisions on the fly, subscribe to on_known_key_received and on_unknown_key_received events. These are fired whenever a trusted or untrusted key is received from the server. For unknown/untrusted keys, you need to set the Action parameter in your on_unknown_key_received event handler to catAcceptOnce (1) or catAcceptPermanently (2) for the connection to proceed.

Once you are all set up, you can go ahead by calling the connect method. This launches the SSH handshake and, if everything has been set up right, establishes a connection to the server. You can now use send and receive methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in async_mode topic to learn more about each mode.

When you are done with the session, call disconnect to shut the connection down.

Hint: If you are only interested in a quick-and-dirty execution of a simple, non-interactive command, SSHClient offers a handy shortcut. connect_and_exec method is a self-contained mechanism which sets up a connection, performs the data exchange internally, and returns the command output. Please keep in mind that you still need to set up the server trust settings as described above for this method to work.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


async_mode	Controls the SSH clients mode of work.
auth_attempts	Specifies the number of SSH password authentication attempts.
commands	Specifies the list of commands to execute.
connected	Specifies whether the client is connected to the SFTP server.
conn_info_client_key_algorithm	Specifies the client's key algorithm.
conn_info_client_key_bits	Specifies the length of the client's key.
conn_info_client_key_fingerprint	The fingerprint (hash value) of the client's public key.
conn_info_close_reason	Contains the line sent by the server just before closing the connection.
conn_info_compression_algorithm_inbound	Compression algorithm for the incoming traffic.
conn_info_compression_algorithm_outbound	Compression algorithm for the outgoing traffic.
conn_info_encryption_algorithm_inbound	Encryption algorithm for the incoming traffic.
conn_info_encryption_algorithm_outbound	Encryption algorithm for the outgoing traffic.
conn_info_inbound_encryption_key_bits	Specifies the length of the key used to encrypt the incoming traffic.
conn_info_kex_algorithm	The key exchange algorithm used during the SSH handshake.
conn_info_kex_bits	The number of bits used by the key exchange algorithm.
conn_info_kex_lines	The contents of the received KexInit packet.
conn_info_mac_algorithm_inbound	MAC algorithm used for the incoming connection.
conn_info_mac_algorithm_outbound	MAC algorithm used for outbound connection.
conn_info_outbound_encryption_key_bits	Specifies the length of the key used to encrypt the outgoing traffic.
conn_info_public_key_algorithm	Specifies the public key algorithm which was used during the SSH handshake.
conn_info_server_key_bits	Specifies the number of bits in the server's key.
conn_info_server_key_fingerprint	The fingerprint (hash value) of the server's public key.
conn_info_server_software_name	Returns the name of the SSH software running on the server side.
conn_info_total_bytes_received	Returns the total number of bytes received over this connection.
conn_info_total_bytes_sent	Returns the total number of bytes sent over this connection.
conn_info_version	Specifies SSH protocol version.
exit_message	Contains the last commands exit message.
exit_signal	Contains the last commands exit signal.
exit_status	Contains the last commands exit status.
external_crypto_async_document_id	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
external_crypto_custom_params	Custom parameters to be passed to the signing service (uninterpreted).
external_crypto_data	Additional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculation	Specifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithm	Specifies the request's signature hash algorithm.
external_crypto_key_id	The ID of the pre-shared key used for DC request authentication.
external_crypto_key_secret	The pre-shared key used for DC request authentication.
external_crypto_method	Specifies the asynchronous signing method.
external_crypto_mode	Specifies the external cryptography mode.
external_crypto_public_key_algorithm	Provide public key algorithm here if the certificate is not available on the pre-signing stage.
fips_mode	Reserved.
key_fingerprint_sha1	Contains the SHA-1 fingerprint (hash) of the key.
key_fingerprint_sha256	Contains the SHA-256 fingerprint (hash) of the key.
key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
password	Specifies user's password on the server.
proxy_settings_address	The IP address of the proxy server.
proxy_settings_authentication	The authentication type used by the proxy server.
proxy_settings_password	The password to authenticate to the proxy server.
proxy_settings_port	The port on the proxy server to connect to.
proxy_settings_proxy_type	The type of the proxy server.
proxy_settings_request_headers	Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_settings_response_body	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_settings_response_headers	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_settings_use_ipv6	Specifies whether IPv6 should be used when connecting through the proxy.
proxy_settings_use_proxy	Enables or disables proxy-driven connection.
proxy_settings_username	Specifies the username credential for proxy authentication.
server_key_algorithm	Specifies the key algorithm.
server_key_bits	The number of bits in the key: the more the better, 2048 or 4096 are typical values.
server_key_comment	The comment for the public key.
server_key_curve	Specifies the elliptical curve when EC cryptography is used.
server_key_dssg	The G (Generator) parameter of the DSS signature key.
server_key_dssp	The P (Prime) parameter of the DSS signature key.
server_key_dssq	The Q (Prime Factor) parameter of the DSS signature key.
server_key_dssx	The X (Private key) parameter of the DSS signature key.
server_key_dssy	The Y (Public key) parameter of the DSS signature key.
server_key_eccd	The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.
server_key_eccqx	The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.
server_key_eccqy	The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.
server_key_ed_private	The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
server_key_ed_public	The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
server_key_fingerprint_md5	Contains the MD5 fingerprint (hash) of the key.
server_key_fingerprint_sha1	Contains the SHA-1 fingerprint (hash) of the key.
server_key_fingerprint_sha256	Contains the SHA-256 fingerprint (hash) of the key.
server_key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
server_key_is_extractable	Whether the key is extractable (e.
server_key_is_private	Whether this key is a private key or not.
server_key_is_public	Whether this key is a public key or not.
server_key_kdf_rounds	Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
server_key_kdf_salt	The salt value used by the Key Derivation Function (KDF) to generate this key.
server_key_key_format	Specifies the format in which the key is stored.
server_key_key_protection_algorithm	Specifies the key protection algorithm.
server_key_rsa_exponent	Returns the e parameter (public exponent) of the RSA key.
server_key_rsaiqmp	Returns the iqmp parameter of the RSA key.
server_key_rsa_modulus	Returns the m parameter (public modulus) of the RSA key.
server_key_rsap	Returns the p parameter (first factor of the common modulus n) of the RSA key.
server_key_rsa_private_exponent	Returns the d parameter (private exponent) of the RSA key.
server_key_rsaq	Returns the q parameter (second factor of the common modulus n) of the RSA key.
server_key_subject	Specifies the public key owner (subject).
socket_dns_mode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
socket_dns_port	Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout	The timeout (in milliseconds) for each DNS query.
socket_dns_servers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout	The timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limit	The maximum number of bytes to read from the socket, per second.
socket_local_address	The local network interface to bind the socket to.
socket_local_port	The local port number to bind the socket to.
socket_outgoing_speed_limit	The maximum number of bytes to write to the socket, per second.
socket_timeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6	Enables or disables IP protocol version 6.
ssh_settings_auto_adjust_ciphers	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	Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
ssh_settings_compression_algorithms	A list of session compression algorithms separated with commas or semicolons.
ssh_settings_compression_level	Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).
ssh_settings_default_window_size	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	A list of session encryption algorithms separated with commas or semicolons.
ssh_settings_force_compression	Whether the SSH client should explicitly request compression.
ssh_settings_gss_auth_types	A comma-separated list of authentication types.
ssh_settings_gss_delegate_creds	Switches credential delegation on or off.
ssh_settings_gss_hostname	The GSS host name, in form of a FQDN (e.
ssh_settings_gss_lib	A path to the GSS-API library (DLL or SO).
ssh_settings_gss_mechanisms	A comma-separated list of GSS mechanisms to use.
ssh_settings_gss_protocols	A comma-separated list of SSPI protocols.
ssh_settings_handshake_timeout	Specifies the maximal time for the SSH handshake to proceed, in seconds.
ssh_settings_kex_algorithms	A list of key exchange algorithms separated with commas or semicolons.
ssh_settings_mac_algorithms	A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.
ssh_settings_max_ssh_packet_size	Specifies the maximum length of one SSH packet in bytes.
ssh_settings_min_window_size	Specifies the minimal internal window size.
ssh_settings_obfuscate_handshake	Enables or disables handshake obfuscation.
ssh_settings_obfuscation_password	Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
ssh_settings_public_key_algorithms	A list of public key algorithms separated with commas or semicolons.
ssh_settings_request_password_change	Whether to request a password change when connecting.
ssh_settings_software_name	The name to be used by the class to identify itself.
ssh_settings_trust_all_keys	Enables or disables explicit trust to all server keys.
ssh_settings_use_auth_agent	Enables or disables the use of external key agent, such as Putty key agent.
ssh_settings_versions	Specifies enabled SSH protocol versions (1 or 2).
subsystem	Specifies the subsystem to request from the server.
terminal_cols	Specifies the width of the pseudoterminal, in characters.
terminal_environment	Specifies the list of environment variables.
terminal_eol_char	Specifies the End-of-Line character or sequence.
terminal_height	Specifies the height of the pseudoterminal, in pixels.
terminal_opcodes	Specifies the operation codes specific for the terminal.
terminal_protocol	The terminal protocol name.
terminal_request_pty	Specifies whether to request a pseudoterminal for the session.
terminal_rows	Specifies the height of the pseudoterminal, in lines.
terminal_width	Specifies the width of the pseudoterminal, in pixels.
trusted_keys_file	Path to the file containing public keys of authorized servers.
username	Specifies client's username on the server.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


config	Sets or retrieves a configuration setting.
connect	Establishes connection to an SSH server.
connect_and_exec	Connects to an SSH server and executes a command in one go.
disconnect	Closes connection to the SSH server.
do_action	Performs an additional action.
ping	Sends a keep-alive request to the SSH server.
poll	Checks whether there is any inbound data readily available.
receive	Reads a portion of received data into a string.
receive_bytes	Reads a portion of received data into a byte array.
receive_bytes_from	Reads a portion of data received via a specific channel into a byte array.
receive_from	Reads a portion of data received via a specific channel into a string.
send	Sends a string to the server.
send_bytes	Sends an array of bytes to the server.
send_special	Sends a special character to the server or remote command.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_auth_attempt	Fires when a single authentication attempt is performed.
on_auth_failed	Fires when a single authentication attempt is failed.
on_auth_succeeded	Reports a successful authentication.
on_banner	Reports the receipt of the Hello message from the server.
on_command_completed	Signifies completion of the command execution.
on_command_start	Marks the commencement of a command execution.
on_connect	This event is fired when an SSH session has been established.
on_data_received	Reports receipt of another chunk of data from the server.
on_data_sent	Notifies the application that a piece of data has been sent to the server.
on_disconnect	This event is fired when the SFTP subsystem connection is closed.
on_error	Information about errors during SFTP connection.
on_external_sign	Handles remote or external signing initiated by the SignExternal method or other source.
on_known_key_received	Signals that the server has introduced itself with a known key.
on_notification	This event notifies the application about an underlying control flow event.
on_password_change_request	This event is fired when a password change is requested.
on_private_key_needed	This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.
on_unknown_key_received	Signals that the server has introduced itself with an unknown key.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


BlockSize	The data block size.
ErrorOrigin	Specifies whether the error is local or remote.
ErrorSeverity	Specifies whether the error is fatal.
LocalCharset	Charset used on the client machine.
RemoteCharset	Charset used on the server.
SendCommandEOF	Defines whether EOF control character should be sent after the command data.
ThrottleControl	Enables or disables throttle control for the connection.
UseStrictKeyExchange	Specifies how strict key exchange is supported.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

async_mode Property

Controls the SSH clients mode of work.

Syntax

def get_async_mode() -> bool: ...
def set_async_mode(value: bool) -> None: ...

async_mode = property(get_async_mode, set_async_mode)

Default Value

FALSE

Remarks

This property defines the way in which the class communicates with the application/user code. async_mode set to false makes the component use synchronous single-thread approach. Synchronous mode is generally simpler to integrate and use, but please keep in mind that the calls like connect, receive or send_bytes may block until their execution completes. In asyncronous mode all operations return immediately, but more care should be taken about handling them in your code properly.

Here are a few highlights of each mode.

Synchronous mode:

All operations are performed within the caller thread context
Operations like connect or send_bytes may block
Use poll to check for the availability of data before reading it out with receive or receive_bytes
Return of a call guarantees completion of the operation
Connection errors are reported straight from the methods via exceptions

Asynchronous mode:

All operations are performed in a separate thread (and so are the event calls!)
Methods like send return immediately
Use on_data_sent and on_data_received events to be notified about actual data transmissions
Return of call only marks the beginning of the operation and does not guarantee its successful completion
Connection errors are reported via on_error event, often followed by on_disconnect.

Please note that this is a very important and sensitive property, which has a wide-scale effect on the way the SSH client works and co-operates with the application. Depending on the value assigned to this setting you may need to work with the component very differently.

When setting this property to true, please make sure that your code is prepared to handle events coming from the context of a different thread.

auth_attempts Property

Specifies the number of SSH password 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

Remarks

In case of password authentication failure provide new password inside the on_auth_failed event handler.

commands Property

Specifies the list of commands to execute.

Syntax

def get_commands() -> str: ...
def set_commands(value: str) -> None: ...

commands = property(get_commands, set_commands)

Default Value

Remarks

Use this property to provide a list of commands to execute remotely. Separate different commands with EOL characters.

When this property is set, the component works in the command mode, meaning each command is executed in its own virtual terminal session. No shell connection is established.

If no commands are provided via this property, the component will establish a shell session.

connected Property

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

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

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

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

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

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

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

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

Remarks

Specifies SSH protocol version.

This property is read-only.

exit_message Property

Contains the last commands exit message.

Syntax

def get_exit_message() -> str: ...

exit_message = property(get_exit_message, None)

Default Value

Remarks

Use this property to access the exit message of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

This property is read-only.

exit_signal Property

Contains the last commands exit signal.

Syntax

def get_exit_signal() -> str: ...

exit_signal = property(get_exit_signal, None)

Default Value

Remarks

Use this property to access the exit signal of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

This property is read-only.

exit_status Property

Contains the last commands exit status.

Syntax

def get_exit_status() -> int: ...

exit_status = property(get_exit_status, None)

Default Value

Remarks

Check this property to obtain the exit status (also sometimes referred to as errorlevel) of the last command or shell session.

This property is read-only.

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_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

external_crypto_key_id Property

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

Syntax

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

Remarks

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

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

Remarks

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth 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_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

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.

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

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());

password Property

Specifies user's password on the server.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

Remarks

Invalid password fires the on_auth_failed event.

proxy_settings_address Property

The IP address of the proxy server.

Syntax

def get_proxy_settings_address() -> str: ...
def set_proxy_settings_address(value: str) -> None: ...

proxy_settings_address = property(get_proxy_settings_address, set_proxy_settings_address)

Default Value

Remarks

The IP address of the proxy server.

proxy_settings_authentication Property

The authentication type used by the proxy server.

Syntax

def get_proxy_settings_authentication() -> int: ...
def set_proxy_settings_authentication(value: int) -> None: ...

proxy_settings_authentication = property(get_proxy_settings_authentication, set_proxy_settings_authentication)

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

proxy_settings_password Property

The password to authenticate to the proxy server.

Syntax

def get_proxy_settings_password() -> str: ...
def set_proxy_settings_password(value: str) -> None: ...

proxy_settings_password = property(get_proxy_settings_password, set_proxy_settings_password)

Default Value

Remarks

The password to authenticate to the proxy server.

proxy_settings_port Property

The port on the proxy server to connect to.

Syntax

def get_proxy_settings_port() -> int: ...
def set_proxy_settings_port(value: int) -> None: ...

proxy_settings_port = property(get_proxy_settings_port, set_proxy_settings_port)

Default Value

Remarks

The port on the proxy server to connect to.

proxy_settings_proxy_type Property

The type of the proxy server.

Syntax

def get_proxy_settings_proxy_type() -> int: ...
def set_proxy_settings_proxy_type(value: int) -> None: ...

proxy_settings_proxy_type = property(get_proxy_settings_proxy_type, set_proxy_settings_proxy_type)

Default Value

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.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

proxy_settings_request_headers Property

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

def get_proxy_settings_request_headers() -> str: ...
def set_proxy_settings_request_headers(value: str) -> None: ...

proxy_settings_request_headers = property(get_proxy_settings_request_headers, set_proxy_settings_request_headers)

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

proxy_settings_response_body Property

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

def get_proxy_settings_response_body() -> str: ...
def set_proxy_settings_response_body(value: str) -> None: ...

proxy_settings_response_body = property(get_proxy_settings_response_body, set_proxy_settings_response_body)

Default Value

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

proxy_settings_response_headers Property

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

def get_proxy_settings_response_headers() -> str: ...
def set_proxy_settings_response_headers(value: str) -> None: ...

proxy_settings_response_headers = property(get_proxy_settings_response_headers, set_proxy_settings_response_headers)

Default Value

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

proxy_settings_use_ipv6 Property

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

def get_proxy_settings_use_ipv6() -> bool: ...
def set_proxy_settings_use_ipv6(value: bool) -> None: ...

proxy_settings_use_ipv6 = property(get_proxy_settings_use_ipv6, set_proxy_settings_use_ipv6)

Default Value

FALSE

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

proxy_settings_use_proxy Property

Enables or disables proxy-driven connection.

Syntax

def get_proxy_settings_use_proxy() -> bool: ...
def set_proxy_settings_use_proxy(value: bool) -> None: ...

proxy_settings_use_proxy = property(get_proxy_settings_use_proxy, set_proxy_settings_use_proxy)

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

proxy_settings_username Property

Specifies the username credential for proxy authentication.

Syntax

def get_proxy_settings_username() -> str: ...
def set_proxy_settings_username(value: str) -> None: ...

proxy_settings_username = property(get_proxy_settings_username, set_proxy_settings_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

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)

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

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.

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

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

Remarks

Specifies the format in which the key is stored.


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`
ckfPuTTY3	`9`

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)

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

Remarks

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


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

socket_dns_port Property

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

Syntax

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

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

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

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

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

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

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

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

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

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)

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

Remarks

Specifies enabled SSH protocol versions (1 or 2).

subsystem Property

Specifies the subsystem to request from the server.

Syntax

def get_subsystem() -> str: ...
def set_subsystem(value: str) -> None: ...

subsystem = property(get_subsystem, set_subsystem)

Default Value

Remarks

Subsystem is a special form of an SSH channel. It is typically used to transfer third-party protocol data, with SFTP being the most widely known.

You can tell class to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property.

terminal_cols Property

Specifies the width of the pseudoterminal, in characters.

Syntax

def get_terminal_cols() -> int: ...
def set_terminal_cols(value: int) -> None: ...

terminal_cols = property(get_terminal_cols, set_terminal_cols)

Default Value

Remarks

Specifies the width of the pseudoterminal, in characters.

terminal_environment Property

Specifies the list of environment variables.

Syntax

def get_terminal_environment() -> str: ...
def set_terminal_environment(value: str) -> None: ...

terminal_environment = property(get_terminal_environment, set_terminal_environment)

Default Value

Remarks

Specifies the list of environment variables.

terminal_eol_char Property

Specifies the End-of-Line character or sequence.

Syntax

def get_terminal_eol_char() -> bytes: ...
def set_terminal_eol_char(value: bytes) -> None: ...

terminal_eol_char = property(get_terminal_eol_char, set_terminal_eol_char)

Remarks

Specifies the End-of-Line character or sequence.

terminal_height Property

Specifies the height of the pseudoterminal, in pixels.

Syntax

def get_terminal_height() -> int: ...
def set_terminal_height(value: int) -> None: ...

terminal_height = property(get_terminal_height, set_terminal_height)

Default Value

Remarks

Specifies the height of the pseudoterminal, in pixels.

terminal_opcodes Property

Specifies the operation codes specific for the terminal.

Syntax

def get_terminal_opcodes() -> str: ...
def set_terminal_opcodes(value: str) -> None: ...

terminal_opcodes = property(get_terminal_opcodes, set_terminal_opcodes)

Default Value

Remarks

Specifies the operation codes specific for the terminal.

terminal_protocol Property

The terminal protocol name.

Syntax

def get_terminal_protocol() -> str: ...
def set_terminal_protocol(value: str) -> None: ...

terminal_protocol = property(get_terminal_protocol, set_terminal_protocol)

Default Value

"vt100"

Remarks

The terminal protocol name.

terminal_request_pty Property

Specifies whether to request a pseudoterminal for the session.

Syntax

def get_terminal_request_pty() -> bool: ...
def set_terminal_request_pty(value: bool) -> None: ...

terminal_request_pty = property(get_terminal_request_pty, set_terminal_request_pty)

Default Value

TRUE

Remarks

Specifies whether to request a pseudoterminal for the session.

terminal_rows Property

Specifies the height of the pseudoterminal, in lines.

Syntax

def get_terminal_rows() -> int: ...
def set_terminal_rows(value: int) -> None: ...

terminal_rows = property(get_terminal_rows, set_terminal_rows)

Default Value

Remarks

Specifies the height of the pseudoterminal, in lines.

terminal_width Property

Specifies the width of the pseudoterminal, in pixels.

Syntax

def get_terminal_width() -> int: ...
def set_terminal_width(value: int) -> None: ...

terminal_width = property(get_terminal_width, set_terminal_width)

Default Value

Remarks

Specifies the width of the pseudoterminal, in pixels.

trusted_keys_file Property

Path to the file containing public 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

Path to the file containing public keys of authorized servers.

username Property

Specifies client's username on the server.

Syntax

def get_username() -> str: ...
def set_username(value: str) -> None: ...

username = property(get_username, set_username)

Default Value

Remarks

Client's password is set by password property. ;

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

Establishes connection to an SSH server.

Syntax

def connect(address: str, port: int) -> None: ...

Remarks

Use this method to connect to the SSH server by providing its Address and Port.

Before connecting to the server you might want to set up your credentials using username and password properties. You might also need to configure the server key validation routine. You can do this by subscribing to on_known_key_received and on_unknown_key_received events and implementing the event handlers as required.

Adjust async_mode before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as connect or send_bytes, are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the async_mode topic.

connect_and_exec Method

Connects to an SSH server and executes a command in one go.

Syntax

def connect_and_exec(address: str, port: int, command: str, want_stdout: bool, want_std_err: bool) -> bytes: ...

Remarks

Use this method to connect to an SSH server at Address and Port and execute a command. The method returns the output of the executed command.

This method is a handy shortcut for running non-interactive commands. It encapsulates calls to connect, receive, disconnect internally to save you time and space.

Please note that connect_and_exec always runs synchronously, thus ignoring the async_mode setting.

disconnect Method

Closes connection to the SSH server.

Syntax

def disconnect() -> None: ...

Remarks

Call this method to terminate the active SSH connection.

Please note that in some cases the component may still have some inbound data cached internally even after the connection is closed. You can read that data out using receive and/or receive_bytes methods.

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

ping Method

Sends a keep-alive request to the SSH server.

Syntax

def ping() -> None: ...

Remarks

Use this method to send a keep-alive message to the SSH server. Keep-alive messages are empty data packets which carry no useful information but are a handy way of checking if the connection is still alive.

poll Method

Checks whether there is any inbound data readily available.

Syntax

def poll(milliseconds: int) -> bool: ...

Remarks

Use this method to check whether there is any incoming data available in the connection. If this method returns true, you can read the data with receive or receive_bytes calls.

Use the Milliseconds parameter to tell the component how long it can wait for the data to arrive.

receive Method

Reads a portion of received data into a string.

Syntax

def receive() -> str: ...

Remarks

Use this method to read out a piece of data received from the server into a string.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use receive_from to read stderr data.

receive_bytes Method

Reads a portion of received data into a byte array.

Syntax

def receive_bytes(max_len: int) -> bytes: ...

Remarks

Use this method to read out a piece of data received from the server into a byte array. Control the maximum length of the data chunk with the MaxLen parameter.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use receive_bytes_from to read stderr data.

receive_bytes_from Method

Reads a portion of data received via a specific channel into a byte array.

Syntax

def receive_bytes_from(channel: int, max_len: int) -> bytes: ...

Remarks

Use this method to read out a piece of data received from the server into a byte array. Specify the channel that you are interested in reading from (0 for stdout, 1 for stderr) via the Channel parameter, and control the maximum length of the data chunk with the MaxLen parameter.

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

Please also note that stdout and stderr channels are fully independent, which implies that data arriving via each channel should be read out separately.

receive_from Method

Reads a portion of data received via a specific channel into a string.

Syntax

def receive_from(channel: int) -> str: ...

Remarks

Use this method to read out a piece of data received from the server into a string. Use the Channel parameter to specify the channel that you would like to read from (0 for stdout, 1 for stderr).

In asynchronous mode a good time to call this method is upon receiving a read notification in on_data_received event handler. When working in asynchronous mode, this call returns immediately.

send Method

Sends a string to the server.

Syntax

def send(data_str: str, add_eol: bool) -> None: ...

Remarks

Use this method to send DataStr to the remote command's stdin channel. Set the AddEOL parameter to true to append the end-of-line character to the string automatically.

Note that in synchronous mode this method may block until the whole string is commited to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the on_data_sent event.

send_bytes Method

Sends an array of bytes to the server.

Syntax

def send_bytes(data: bytes) -> None: ...

Remarks

Use this method to send Data to the remote command's stdin channel.

Note that in synchronous mode this method may block until the whole byte array is commited to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the on_data_sent event.

send_special Method

Sends a special character to the server or remote command.

Syntax

def send_special(special_char: str) -> None: ...

Remarks

Use this method to send a special or control character to the SSH server or the command being executed. Specify the character id via the SpecialChar parameter.

Currently the only supported special character is "eof", which is sometimes used as a way to close the stdin channel gracefully.

on_auth_attempt Event

Fires when a single authentication attempt is performed.

Syntax

class SSHClientAuthAttemptEventParams(object):
  @property
  def auth_type() -> int: ...

# In class SSHClient:
@property
def on_auth_attempt() -> Callable[[SSHClientAuthAttemptEventParams], None]: ...
@on_auth_attempt.setter
def on_auth_attempt(event_hook: Callable[[SSHClientAuthAttemptEventParams], None]) -> None: ...

Remarks

This event is fired each time a single authentication attempt is performed. AuthType parameter specifies the type of authentication. Note, this event could be fired more than once if the client tries different authentication methods one after another.

on_auth_failed Event

Fires when a single authentication attempt is failed.

Syntax

class SSHClientAuthFailedEventParams(object):
  @property
  def authentication_type() -> int: ...

# In class SSHClient:
@property
def on_auth_failed() -> Callable[[SSHClientAuthFailedEventParams], None]: ...
@on_auth_failed.setter
def on_auth_failed(event_hook: Callable[[SSHClientAuthFailedEventParams], None]) -> None: ...

Remarks

This event is fired each time a single authentication attempt fails. AuthType parameter specifies the type of authentication.

As SSH may try a number of authentication attempts of different types or with different parameters (such as public keys) during one session, this event may be fired more than once. It is not critical and may not lead to closing of the connection.

on_auth_succeeded Event

Reports a successful authentication.

Syntax

class SSHClientAuthSucceededEventParams(object):
# In class SSHClient:
@property
def on_auth_succeeded() -> Callable[[SSHClientAuthSucceededEventParams], None]: ...
@on_auth_succeeded.setter
def on_auth_succeeded(event_hook: Callable[[SSHClientAuthSucceededEventParams], None]) -> None: ...

Remarks

This event may be preceded by some on_auth_failed events if the client tries different authentication methods one after another.

on_banner Event

Reports the receipt of the Hello message from the server.

Syntax

class SSHClientBannerEventParams(object):
  @property
  def text() -> bytes: ...

  @property
  def language() -> bytes: ...

# In class SSHClient:
@property
def on_banner() -> Callable[[SSHClientBannerEventParams], None]: ...
@on_banner.setter
def on_banner(event_hook: Callable[[SSHClientBannerEventParams], None]) -> None: ...

Remarks

SFPTClient fires this event when it receives hello message from the server.

on_command_completed Event

Signifies completion of the command execution.

Syntax

class SSHClientCommandCompletedEventParams(object):
  @property
  def command() -> str: ...

  @property
  def exit_status() -> int: ...

  @property
  def exit_message() -> str: ...

  @property
  def exit_signal() -> str: ...

# In class SSHClient:
@property
def on_command_completed() -> Callable[[SSHClientCommandCompletedEventParams], None]: ...
@on_command_completed.setter
def on_command_completed(event_hook: Callable[[SSHClientCommandCompletedEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about completion of the remote command execution. This event fires for every command in the commands list. The Command parameter indicates the command being completed.

ExitStatus specifies the command's return code. ExitMessage or ExitSignal parameters provide error details if the command execution was terminated forcefully,

on_command_start Event

Marks the commencement of a command execution.

Syntax

class SSHClientCommandStartEventParams(object):
  @property
  def command() -> str: ...

# In class SSHClient:
@property
def on_command_start() -> Callable[[SSHClientCommandStartEventParams], None]: ...
@on_command_start.setter
def on_command_start(event_hook: Callable[[SSHClientCommandStartEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about the start of execution of a remote command. The Command parameter indicates the command being started.

This event is fired for all commands in the commands list, in order. The completion of the command is reported via the on_command_completed event.

on_connect Event

This event is fired when an SSH session has been established.

Syntax

class SSHClientConnectEventParams(object):
# In class SSHClient:
@property
def on_connect() -> Callable[[SSHClientConnectEventParams], None]: ...
@on_connect.setter
def on_connect(event_hook: Callable[[SSHClientConnectEventParams], None]) -> None: ...

Remarks

Use this event to track the moment when SSH session has been set up.

on_data_received Event

Reports receipt of another chunk of data from the server.

Syntax

class SSHClientDataReceivedEventParams(object):
  @property
  def channel() -> int: ...

  @property
  def bytes_received() -> int: ...

  @property
  def total_bytes_pending() -> int: ...

# In class SSHClient:
@property
def on_data_received() -> Callable[[SSHClientDataReceivedEventParams], None]: ...
@on_data_received.setter
def on_data_received(event_hook: Callable[[SSHClientDataReceivedEventParams], None]) -> None: ...

Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use receive or receive_bytes methods to read out the received data.

The Channel parameter indicates the channel on which the data was received: stdout (0) or stderr (1). BytesReceived specify the size of the newly received chunk, and TotalBytesPending contain the total number of bytes available for reading.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

on_data_sent Event

Notifies the application that a piece of data has been sent to the server.

Syntax

class SSHClientDataSentEventParams(object):
  @property
  def bytes_sent() -> int: ...

  @property
  def bytes_pending() -> int: ...

# In class SSHClient:
@property
def on_data_sent() -> Callable[[SSHClientDataSentEventParams], None]: ...
@on_data_sent.setter
def on_data_sent(event_hook: Callable[[SSHClientDataSentEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about the outbound data flow. This event fires following a call to send or send_bytes methods to notify the application that the data provided has been sent to the server. This event may fire more than once for each send or send_bytes call, subject to the volume of data being sent and the settings of the server.

The BytesSent parameter specifies the number of bytes that has just been sent to the server. The BytesPending indicate the number of bytes that remain cached in the internal buffer. Any bytes cached in such way will be sent again on the next available opportunity and reported via a separate on_data_sent event invocation.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

on_disconnect Event

This event is fired when the SFTP subsystem connection is closed.

Syntax

class SSHClientDisconnectEventParams(object):
  @property
  def close_reason() -> int: ...

# In class SSHClient:
@property
def on_disconnect() -> Callable[[SSHClientDisconnectEventParams], None]: ...
@on_disconnect.setter
def on_disconnect(event_hook: Callable[[SSHClientDisconnectEventParams], None]) -> None: ...

Remarks

Do not perform any file operations after this event has been fired.

on_error Event

Information about errors during SFTP connection.

Syntax

class SSHClientErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class SSHClient:
@property
def on_error() -> Callable[[SSHClientErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SSHClientErrorEventParams], 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 SSHClientExternalSignEventParams(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 SSHClient:
@property
def on_external_sign() -> Callable[[SSHClientExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[SSHClientExternalSignEventParams], 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_known_key_received Event

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

Syntax

class SSHClientKnownKeyReceivedEventParams(object):
  @property
  def algorithm() -> str: ...

  @property
  def bits() -> int: ...

  @property
  def fingerprint_sha256() -> str: ...

# In class SSHClient:
@property
def on_known_key_received() -> Callable[[SSHClientKnownKeyReceivedEventParams], None]: ...
@on_known_key_received.setter
def on_known_key_received(event_hook: Callable[[SSHClientKnownKeyReceivedEventParams], 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_notification Event

This event notifies the application about an underlying control flow event.

Syntax

class SSHClientNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class SSHClient:
@property
def on_notification() -> Callable[[SSHClientNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[SSHClientNotificationEventParams], 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

This event is fired when a password change is requested.

Syntax

class SSHClientPasswordChangeRequestEventParams(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 SSHClient:
@property
def on_password_change_request() -> Callable[[SSHClientPasswordChangeRequestEventParams], None]: ...
@on_password_change_request.setter
def on_password_change_request(event_hook: Callable[[SSHClientPasswordChangeRequestEventParams], None]) -> None: ...

Remarks

This event is fired by the class when a password change is requested by the server. Prompt contains the password prompt message. Handler should either provide the new password via NewPassword, or deny the request by setting Cancel to true.

on_private_key_needed Event

This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.

Syntax

class SSHClientPrivateKeyNeededEventParams(object):
  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...

# In class SSHClient:
@property
def on_private_key_needed() -> Callable[[SSHClientPrivateKeyNeededEventParams], None]: ...
@on_private_key_needed.setter
def on_private_key_needed(event_hook: Callable[[SSHClientPrivateKeyNeededEventParams], None]) -> None: ...

Remarks

Set Skip to true when it is not possible to load the missing key for some reason.

on_unknown_key_received Event

Signals that the server has introduced itself with an unknown key.

Syntax

class SSHClientUnknownKeyReceivedEventParams(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 SSHClient:
@property
def on_unknown_key_received() -> Callable[[SSHClientUnknownKeyReceivedEventParams], None]: ...
@on_unknown_key_received.setter
def on_unknown_key_received(event_hook: Callable[[SSHClientUnknownKeyReceivedEventParams], 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:


catAcceptOnce	`1`	Accept the key for the current session only.
catAcceptPermanently	`2`	Accept the key for the current session and store the key to the trusted keys list.
catReject	`3`	Reject the key and close the connection.

Note that accepting an unknown and unchecked key may be risky.

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

SSHClient Config Settings

BlockSize: The data block size.

This property specifies the data block size to use.

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.

LocalCharset: Charset used on the client machine.

This property specifies the charset used on the local client computer.

RemoteCharset: Charset used on the server.

This property specifies the charset used on the server.

SendCommandEOF: Defines whether EOF control character should be sent after the command data.

Enable this property to enforce sending of a trailing EOF character after the command data.

ThrottleControl: Enables or disables throttle control for the connection.

Use this property to enable or disable throttle control.

UseStrictKeyExchange: Specifies how strict key exchange is supported.

This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client classes and kex-strict-s-v00@openssh.com for server classes in the list of supported key exchange algorithms.

Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:


`0`	Disabled. Strict key exchange is not supported in the class.
`1` (default)	Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
`2`	Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack.
`3`	Required. If the remote host does not support strict key exchange the connection will fail.

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:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

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:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are 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.