SSHClient Class

Properties   Methods   Events   Config Settings   Errors  

The SSHClient class implements a fully functional, open-ended Secure Shell (SSH) client.

Syntax

class ipworksssh.SSHClient

Remarks

The SSHClient class can be used to perform any number of tasks secured by the Secure Shell (SSH) protocol. First set ssh_host, ssh_user and either ssh_password or the ssh_cert* properties , then call ssh_logon to establish a secure connection.

To open channels, use open_channel. To open a channel to tunnel data to a remote machine, call open_tcp_ip_channel. The channels property contains a list of all of the channels open for the current instance of the class.

Once a "session" channel has been opened, you can call start_service to initialize a service on that channel. If you are using a "shell" service, you can call open_terminal to establish a pseudo-terminal for formatting the data output from the shell.

Data received from the server will be fired through on_ssh_channel_data events. Any requests received can be processed through the on_ssh_channel_request event.

Property List

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

Method List

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

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.

Config Settings

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

ssh_channel_count Property

The number of records in the arrays.

Syntax

def get_ssh_channel_count() -> int: ...

ssh_channel_count = property(get_ssh_channel_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• bytes_sent
• channel_eol
• channel_id
• firewall_auto_detect
• firewall_host
• firewall_password
• firewall_port
• firewall_type
• firewall_user
• max_channel_length
• ready_to_send
• record_length
• service
• ssh_accept_server_host_key_effective_date
• ssh_accept_server_host_key_encoded
• ssh_accept_server_host_key_expiration_date
• ssh_accept_server_host_key_extended_key_usage
• ssh_accept_server_host_key_fingerprint
• ssh_accept_server_host_key_fingerprint_sha1
• ssh_accept_server_host_key_fingerprint_sha256
• ssh_accept_server_host_key_issuer
• ssh_accept_server_host_key_private_key
• ssh_accept_server_host_key_private_key_available
• ssh_accept_server_host_key_private_key_container
• ssh_accept_server_host_key_public_key
• ssh_accept_server_host_key_public_key_algorithm
• ssh_accept_server_host_key_public_key_length
• ssh_accept_server_host_key_serial_number
• ssh_accept_server_host_key_signature_algorithm
• ssh_accept_server_host_key_store
• ssh_accept_server_host_key_store_password
• ssh_accept_server_host_key_store_type
• ssh_accept_server_host_key_subject
• ssh_accept_server_host_key_subject_alt_names
• ssh_accept_server_host_key_thumbprint_md5
• ssh_accept_server_host_key_thumbprint_sha1
• ssh_accept_server_host_key_thumbprint_sha256
• ssh_accept_server_host_key_usage
• ssh_accept_server_host_key_usage_flags
• ssh_accept_server_host_key_version
• ssh_cert_effective_date
• ssh_cert_encoded
• ssh_cert_expiration_date
• ssh_cert_extended_key_usage
• ssh_cert_fingerprint
• ssh_cert_fingerprint_sha1
• ssh_cert_fingerprint_sha256
• ssh_cert_issuer
• ssh_cert_private_key
• ssh_cert_private_key_available
• ssh_cert_private_key_container
• ssh_cert_public_key
• ssh_cert_public_key_algorithm
• ssh_cert_public_key_length
• ssh_cert_serial_number
• ssh_cert_signature_algorithm
• ssh_cert_store
• ssh_cert_store_password
• ssh_cert_store_type
• ssh_cert_subject
• ssh_cert_subject_alt_names
• ssh_cert_thumbprint_md5
• ssh_cert_thumbprint_sha1
• ssh_cert_thumbprint_sha256
• ssh_cert_usage
• ssh_cert_usage_flags
• ssh_cert_version

The array indices start at 0 and end at ssh_channel_count - 1.

This property is read-only.

bytes_sent Property

This property specifies the number of bytes actually sent after a sending channel data.

Syntax

def get_bytes_sent(ssh_channel_id: int) -> int: ...

Default Value

0

Remarks

This property specifies the number of bytes actually sent after a sending channel data.

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

This property is read-only.

channel_eol Property

Breaks the incoming data stream into chunks separated by EOL .

Syntax

def get_channel_eol(ssh_channel_id: int) -> str: ...
def set_channel_eol(ssh_channel_id: int, value: str) -> None: ...

Default Value

""

Remarks

Breaks the incoming data stream into chunks separated by EOL.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

channeleol and maxchannellength must be set together or unexpected behavior could occur.

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

channel_id Property

This property provides an Id generated by the class to identify the current Secure Shell (SSH) channel.

Syntax

def get_channel_id(ssh_channel_id: int) -> str: ...

Default Value

""

Remarks

This property provides an Id generated by the class to identify the current Secure Shell (SSH) channel.

This Id is unique to this channel.

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

This property is read-only.

max_channel_length Property

This property specifies the maximum amount of data to accumulate when no EOL is found.

Syntax

def get_max_channel_length(ssh_channel_id: int) -> int: ...
def set_max_channel_length(ssh_channel_id: int, value: int) -> None: ...

Default Value

0

Remarks

This property specifies the maximum amount of data to accumulate when no EOL is found.

maxchannellength is the size of an internal buffer, which holds received data while waiting for a channeleol string.

If the channeleol string is found in the input stream before MaxChannelLength bytes are received, the onsshchanneldata event is fired with the ChannelDataEOLFound parameter set to True, and the buffer is reset.

If no channeleol is found, and maxchannellength bytes are accumulated in the buffer, the onsshchanneldata event is fired with the ChannelDataEOLFound parameter set to False, and the buffer is reset.

channeleol and maxchannellength must be set together or unexpected behavior could occur.

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

ready_to_send Property

This property is True when data can be sent over the Secure Shell (SSH) channel.

Syntax

def get_ready_to_send(ssh_channel_id: int) -> bool: ...

Default Value

FALSE

Remarks

This property is True when data can be sent over the Secure Shell (SSH) channel.

When timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor onsshchannelreadytosend or readytosend to determine when data can be sent again.

When timeout is set to a positive value, the class will block when sending data until the data can be successfully sent and onsshchannelreadytosend and readytosend do not need to be monitored.

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

This property is read-only.

record_length Property

This property holds the current record length set by ChangeRecordLength .

Syntax

def get_record_length(ssh_channel_id: int) -> int: ...

Default Value

0

Remarks

This property holds the current record length set by changerecordlength. When this value is a positive number, the class will accumulate data until recordlength is reached and only then will it fire the onsshchanneldatain event with the data of length recordlength. This allows data to be received as records of known length. This value can be changed at any time by calling changerecordlength, including within the onsshchanneldatain event.

A value of 0 (default) means this setting is not used.

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

This property is read-only.

service Property

This property holds the channel type that was requested when opening the channel.

Syntax

def get_service(ssh_channel_id: int) -> str: ...

Default Value

""

Remarks

This property holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip".

The ssh_channel_id parameter specifies the index of the item in the array. The size of the array is controlled by the ssh_channel_count property.

This property is read-only.

connected Property

Whether the class is connected.

Syntax

def get_connected() -> bool: ...

connected = property(get_connected, None)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

local_port Property

The TCP port in the local host where the class binds.

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the local_port property after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

ssh_accept_server_host_key_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssh_accept_server_host_key_effective_date() -> str: ...

ssh_accept_server_host_key_effective_date = property(get_ssh_accept_server_host_key_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssh_accept_server_host_key_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssh_accept_server_host_key_expiration_date() -> str: ...

ssh_accept_server_host_key_expiration_date = property(get_ssh_accept_server_host_key_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssh_accept_server_host_key_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssh_accept_server_host_key_extended_key_usage() -> str: ...

ssh_accept_server_host_key_extended_key_usage = property(get_ssh_accept_server_host_key_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssh_accept_server_host_key_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssh_accept_server_host_key_fingerprint() -> str: ...

ssh_accept_server_host_key_fingerprint = property(get_ssh_accept_server_host_key_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssh_accept_server_host_key_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssh_accept_server_host_key_fingerprint_sha1() -> str: ...

ssh_accept_server_host_key_fingerprint_sha1 = property(get_ssh_accept_server_host_key_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssh_accept_server_host_key_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssh_accept_server_host_key_fingerprint_sha256() -> str: ...

ssh_accept_server_host_key_fingerprint_sha256 = property(get_ssh_accept_server_host_key_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssh_accept_server_host_key_issuer Property

The issuer of the certificate.

Syntax

def get_ssh_accept_server_host_key_issuer() -> str: ...

ssh_accept_server_host_key_issuer = property(get_ssh_accept_server_host_key_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssh_accept_server_host_key_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssh_accept_server_host_key_private_key() -> str: ...

ssh_accept_server_host_key_private_key = property(get_ssh_accept_server_host_key_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssh_accept_server_host_key_private_key may be available but not exportable. In this case, ssh_accept_server_host_key_private_key returns an empty string.

This property is read-only.

ssh_accept_server_host_key_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssh_accept_server_host_key_private_key_available() -> bool: ...

ssh_accept_server_host_key_private_key_available = property(get_ssh_accept_server_host_key_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssh_accept_server_host_key_private_key is available for the selected certificate. If ssh_accept_server_host_key_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssh_accept_server_host_key_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssh_accept_server_host_key_private_key_container() -> str: ...

ssh_accept_server_host_key_private_key_container = property(get_ssh_accept_server_host_key_private_key_container, None)

Default Value

""

Remarks

The name of the ssh_accept_server_host_key_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssh_accept_server_host_key_public_key Property

The public key of the certificate.

Syntax

def get_ssh_accept_server_host_key_public_key() -> str: ...

ssh_accept_server_host_key_public_key = property(get_ssh_accept_server_host_key_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssh_accept_server_host_key_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssh_accept_server_host_key_public_key_algorithm() -> str: ...

ssh_accept_server_host_key_public_key_algorithm = property(get_ssh_accept_server_host_key_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssh_accept_server_host_key_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssh_accept_server_host_key_public_key_length() -> int: ...

ssh_accept_server_host_key_public_key_length = property(get_ssh_accept_server_host_key_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssh_accept_server_host_key_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssh_accept_server_host_key_serial_number() -> str: ...

ssh_accept_server_host_key_serial_number = property(get_ssh_accept_server_host_key_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssh_accept_server_host_key_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssh_accept_server_host_key_signature_algorithm() -> str: ...

ssh_accept_server_host_key_signature_algorithm = property(get_ssh_accept_server_host_key_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssh_accept_server_host_key_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssh_accept_server_host_key_store() -> bytes: ...
def set_ssh_accept_server_host_key_store(value: bytes) -> None: ...

ssh_accept_server_host_key_store = property(get_ssh_accept_server_host_key_store, set_ssh_accept_server_host_key_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssh_accept_server_host_key_store_type property denotes the type of the certificate store specified by ssh_accept_server_host_key_store. If the store is password-protected, specify the password in ssh_accept_server_host_key_store_password.

ssh_accept_server_host_key_store is used in conjunction with the ssh_accept_server_host_key_subject property to specify client certificates. If ssh_accept_server_host_key_store has a value, and ssh_accept_server_host_key_subject or ssh_accept_server_host_key_encoded is set, a search for a certificate is initiated. Please see the ssh_accept_server_host_key_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssh_accept_server_host_key_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssh_accept_server_host_key_store_password() -> str: ...
def set_ssh_accept_server_host_key_store_password(value: str) -> None: ...

ssh_accept_server_host_key_store_password = property(get_ssh_accept_server_host_key_store_password, set_ssh_accept_server_host_key_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssh_accept_server_host_key_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssh_accept_server_host_key_store_type() -> int: ...
def set_ssh_accept_server_host_key_store_type(value: int) -> None: ...

ssh_accept_server_host_key_store_type = property(get_ssh_accept_server_host_key_store_type, set_ssh_accept_server_host_key_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssh_accept_server_host_key_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssh_accept_server_host_key_subject_alt_names() -> str: ...

ssh_accept_server_host_key_subject_alt_names = property(get_ssh_accept_server_host_key_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssh_accept_server_host_key_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssh_accept_server_host_key_thumbprint_md5() -> str: ...

ssh_accept_server_host_key_thumbprint_md5 = property(get_ssh_accept_server_host_key_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssh_accept_server_host_key_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssh_accept_server_host_key_thumbprint_sha1() -> str: ...

ssh_accept_server_host_key_thumbprint_sha1 = property(get_ssh_accept_server_host_key_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssh_accept_server_host_key_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssh_accept_server_host_key_thumbprint_sha256() -> str: ...

ssh_accept_server_host_key_thumbprint_sha256 = property(get_ssh_accept_server_host_key_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssh_accept_server_host_key_usage Property

The text description of UsageFlags .

Syntax

def get_ssh_accept_server_host_key_usage() -> str: ...

ssh_accept_server_host_key_usage = property(get_ssh_accept_server_host_key_usage, None)

Default Value

""

Remarks

The text description of ssh_accept_server_host_key_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssh_accept_server_host_key_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssh_accept_server_host_key_usage_flags() -> int: ...

ssh_accept_server_host_key_usage_flags = property(get_ssh_accept_server_host_key_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssh_accept_server_host_key_usage_flags is a combination of the following flags:

Please see the ssh_accept_server_host_key_usage property for a text representation of ssh_accept_server_host_key_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssh_accept_server_host_key_version Property

The certificate's version number.

Syntax

def get_ssh_accept_server_host_key_version() -> str: ...

ssh_accept_server_host_key_version = property(get_ssh_accept_server_host_key_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssh_accept_server_host_key_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssh_accept_server_host_key_subject() -> str: ...
def set_ssh_accept_server_host_key_subject(value: str) -> None: ...

ssh_accept_server_host_key_subject = property(get_ssh_accept_server_host_key_subject, set_ssh_accept_server_host_key_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssh_accept_server_host_key_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssh_accept_server_host_key_encoded() -> bytes: ...
def set_ssh_accept_server_host_key_encoded(value: bytes) -> None: ...

ssh_accept_server_host_key_encoded = property(get_ssh_accept_server_host_key_encoded, set_ssh_accept_server_host_key_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssh_accept_server_host_key_store and ssh_accept_server_host_key_subject properties also may be used to specify a certificate.

When ssh_accept_server_host_key_encoded is set, a search is initiated in the current ssh_accept_server_host_key_store for the private key of the certificate. If the key is found, ssh_accept_server_host_key_subject is updated to reflect the full subject of the selected certificate; otherwise, ssh_accept_server_host_key_subject is set to an empty string.

ssh_auth_mode Property

The authentication method to be used with the class when calling SSHLogon .

Syntax

def get_ssh_auth_mode() -> int: ...
def set_ssh_auth_mode(value: int) -> None: ...

ssh_auth_mode = property(get_ssh_auth_mode, set_ssh_auth_mode)

Default Value

2

Remarks

The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to ssh_logon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the ssh_host containing the ssh_user. The server will respond containing a list of methods by which that user may be authenticated.

The class will attempt to authenticate the user by one of those methods based on the value of ssh_auth_mode and other property values supplied by the user. Currently, the class supports the following authentication methods:

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

ssh_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssh_cert_effective_date() -> str: ...

ssh_cert_effective_date = property(get_ssh_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssh_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssh_cert_expiration_date() -> str: ...

ssh_cert_expiration_date = property(get_ssh_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssh_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssh_cert_extended_key_usage() -> str: ...

ssh_cert_extended_key_usage = property(get_ssh_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssh_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssh_cert_fingerprint() -> str: ...

ssh_cert_fingerprint = property(get_ssh_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssh_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssh_cert_fingerprint_sha1() -> str: ...

ssh_cert_fingerprint_sha1 = property(get_ssh_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssh_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssh_cert_fingerprint_sha256() -> str: ...

ssh_cert_fingerprint_sha256 = property(get_ssh_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssh_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssh_cert_issuer() -> str: ...

ssh_cert_issuer = property(get_ssh_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssh_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssh_cert_private_key() -> str: ...

ssh_cert_private_key = property(get_ssh_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssh_cert_private_key may be available but not exportable. In this case, ssh_cert_private_key returns an empty string.

This property is read-only.

ssh_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssh_cert_private_key_available() -> bool: ...

ssh_cert_private_key_available = property(get_ssh_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssh_cert_private_key is available for the selected certificate. If ssh_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssh_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssh_cert_private_key_container() -> str: ...

ssh_cert_private_key_container = property(get_ssh_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssh_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssh_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssh_cert_public_key() -> str: ...

ssh_cert_public_key = property(get_ssh_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssh_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssh_cert_public_key_algorithm() -> str: ...

ssh_cert_public_key_algorithm = property(get_ssh_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssh_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssh_cert_public_key_length() -> int: ...

ssh_cert_public_key_length = property(get_ssh_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssh_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssh_cert_serial_number() -> str: ...

ssh_cert_serial_number = property(get_ssh_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssh_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssh_cert_signature_algorithm() -> str: ...

ssh_cert_signature_algorithm = property(get_ssh_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssh_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssh_cert_store() -> bytes: ...
def set_ssh_cert_store(value: bytes) -> None: ...

ssh_cert_store = property(get_ssh_cert_store, set_ssh_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssh_cert_store_type property denotes the type of the certificate store specified by ssh_cert_store. If the store is password-protected, specify the password in ssh_cert_store_password.

ssh_cert_store is used in conjunction with the ssh_cert_subject property to specify client certificates. If ssh_cert_store has a value, and ssh_cert_subject or ssh_cert_encoded is set, a search for a certificate is initiated. Please see the ssh_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssh_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssh_cert_store_password() -> str: ...
def set_ssh_cert_store_password(value: str) -> None: ...

ssh_cert_store_password = property(get_ssh_cert_store_password, set_ssh_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssh_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssh_cert_store_type() -> int: ...
def set_ssh_cert_store_type(value: int) -> None: ...

ssh_cert_store_type = property(get_ssh_cert_store_type, set_ssh_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssh_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssh_cert_subject_alt_names() -> str: ...

ssh_cert_subject_alt_names = property(get_ssh_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssh_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssh_cert_thumbprint_md5() -> str: ...

ssh_cert_thumbprint_md5 = property(get_ssh_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssh_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssh_cert_thumbprint_sha1() -> str: ...

ssh_cert_thumbprint_sha1 = property(get_ssh_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssh_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssh_cert_thumbprint_sha256() -> str: ...

ssh_cert_thumbprint_sha256 = property(get_ssh_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssh_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssh_cert_usage() -> str: ...

ssh_cert_usage = property(get_ssh_cert_usage, None)

Default Value

""

Remarks

The text description of ssh_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssh_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssh_cert_usage_flags() -> int: ...

ssh_cert_usage_flags = property(get_ssh_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssh_cert_usage_flags is a combination of the following flags:

Please see the ssh_cert_usage property for a text representation of ssh_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssh_cert_version Property

The certificate's version number.

Syntax

def get_ssh_cert_version() -> str: ...

ssh_cert_version = property(get_ssh_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssh_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssh_cert_subject() -> str: ...
def set_ssh_cert_subject(value: str) -> None: ...

ssh_cert_subject = property(get_ssh_cert_subject, set_ssh_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssh_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssh_cert_encoded() -> bytes: ...
def set_ssh_cert_encoded(value: bytes) -> None: ...

ssh_cert_encoded = property(get_ssh_cert_encoded, set_ssh_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssh_cert_store and ssh_cert_subject properties also may be used to specify a certificate.

When ssh_cert_encoded is set, a search is initiated in the current ssh_cert_store for the private key of the certificate. If the key is found, ssh_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssh_cert_subject is set to an empty string.

ssh_compression_algorithms Property

The comma-separated list containing all allowable compression algorithms.

Syntax

def get_ssh_compression_algorithms() -> str: ...
def set_ssh_compression_algorithms(value: str) -> None: ...

ssh_compression_algorithms = property(get_ssh_compression_algorithms, set_ssh_compression_algorithms)

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:

• zlib
• zlib@openssh.com
• none

ssh_encryption_algorithms Property

The comma-separated list containing all allowable encryption algorithms.

Syntax

def get_ssh_encryption_algorithms() -> str: ...
def set_ssh_encryption_algorithms(value: str) -> None: ...

ssh_encryption_algorithms = property(get_ssh_encryption_algorithms, set_ssh_encryption_algorithms)

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:

ssh_host Property

The address of the Secure Shell (SSH) host.

Syntax

def get_ssh_host() -> str: ...
def set_ssh_host(value: str) -> None: ...

ssh_host = property(get_ssh_host, set_ssh_host)

Default Value

""

Remarks

The ssh_host property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the ssh_host property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the ssh_host property is set to the corresponding address. If the search is not successful, an error is returned.

The ssh_host must be the same host that will be assumed for SSH as for the remote service being connected to.

ssh_key_exchange_algorithms Property

The comma-separated list containing all allowable key exchange algorithms.

Syntax

def get_ssh_key_exchange_algorithms() -> str: ...
def set_ssh_key_exchange_algorithms(value: str) -> None: ...

ssh_key_exchange_algorithms = property(get_ssh_key_exchange_algorithms, set_ssh_key_exchange_algorithms)

Default Value

"curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==,gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==,gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g=="

Remarks

Secure Shell (SSH) allows different algorithms to be negotiated for use when establishing the security layer of the connection. This property controls the key-exchange algorithm list supplied by the class to the ssh_host. It is a comma-separated list containing the names of key-exchange algorithms as defined by section 6.5 of the SSH Transport Layer specification (RFC 4253). The key-exchange algorithms specified in RFC 4419 and RFC 8732 are also supported.

The value of this property must be a comma-separated list containing one or more of the following values:

• curve25519-sha256
• curve25519-sha256@libssh.org
• diffie-hellman-group1-sha1
• diffie-hellman-group14-sha1
• diffie-hellman-group14-sha256
• diffie-hellman-group16-sha512
• diffie-hellman-group18-sha512
• diffie-hellman-group-exchange-sha256
• diffie-hellman-group-exchange-sha1
• ecdh-sha2-nistp256
• ecdh-sha2-nistp384
• ecdh-sha2-nistp521
• gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
• gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
• gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
• gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==

ssh_mac_algorithms Property

The comma-separated list containing all allowable message authentication algorithms.

Syntax

def get_ssh_mac_algorithms() -> str: ...
def set_ssh_mac_algorithms(value: str) -> None: ...

ssh_mac_algorithms = property(get_ssh_mac_algorithms, set_ssh_mac_algorithms)

Default Value

"hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,hmac-sha2-256-96-etm@openssh.com,hmac-sha2-512-96-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com"

Remarks

Secure Shell (SSH) allows different algorithms to be negotiated for use when establishing the security layer of the connection. ssh_mac_algorithms controls the message authentication code (MAC) algorithm list supplied by the class to the ssh_host. It is a comma-separated list containing the names of message authentication code (MAC) algorithms as defined by section 6.4 of the SSH Transport Layer specification (RFC 4253).

The value of this property must be a comma-separated list containing one or more of the following values:

• hmac-sha1
• hmac-md5
• hmac-sha1-96
• hmac-md5-96
• hmac-sha2-256
• hmac-sha2-256-96
• hmac-sha2-512
• hmac-sha2-512-96
• hmac-ripemd160
• hmac-ripemd160-96
• hmac-sha2-256-etm@openssh.com
• hmac-sha2-512-etm@openssh.com
• hmac-sha2-256-96-etm@openssh.com
• hmac-sha2-512-96-etm@openssh.com
• umac-64@openssh.com
• umac-64-etm@openssh.com
• umac-128@openssh.com
• umac-128-etm@openssh.com

ssh_password Property

The password for Secure Shell (SSH) password-based authentication.

Syntax

def get_ssh_password() -> str: ...
def set_ssh_password(value: str) -> None: ...

ssh_password = property(get_ssh_password, set_ssh_password)

Default Value

""

Remarks

ssh_password specifies the password that is used to authenticate the client to the SSH server.

ssh_port Property

The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.

Syntax

def get_ssh_port() -> int: ...
def set_ssh_port(value: int) -> None: ...

ssh_port = property(get_ssh_port, set_ssh_port)

Default Value

22

Remarks

The ssh_port specifies a service port on the SSH host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

ssh_public_key_algorithms Property

The comma-separated list containing all allowable public key algorithms for the Secure Shell (SSH) server's public key.

Syntax

def get_ssh_public_key_algorithms() -> str: ...
def set_ssh_public_key_algorithms(value: str) -> None: ...

ssh_public_key_algorithms = property(get_ssh_public_key_algorithms, set_ssh_public_key_algorithms)

Default Value

"ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-ed448,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss"

Remarks

SSH allows different algorithms to be negotiated for use when establishing the security layer of the connection. ssh_public_key_algorithms controls the public key algorithm list supplied by the class to the ssh_host. It is a comma-separated list containing the names of public key algorithms as defined by section 6.6 of the SSH Transport Layer specification (RFC 4253).

The value of this property must be a comma-separated list containing one or more of the following values:

Note: The algorithms listed by this property control only the allowed public key algorithms for the SSH server's public key. This is used when authenticating the SSH server's public key. In most SSH server implementations, this list has no bearing on the public key algorithms that can be used by the client when authenticating to the SSH server using public key authentication.

ssh_user Property

The username for Secure Shell (SSH) authentication.

Syntax

def get_ssh_user() -> str: ...
def set_ssh_user(value: str) -> None: ...

ssh_user = property(get_ssh_user, set_ssh_user)

Default Value

""

Remarks

ssh_user specifies the username that is used to authenticate the client to the SSH server. This property is required.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

timeout Property

This property includes the timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

change_record_length Method

Changes the length of received data records.

Syntax

def change_record_length(channel_id: str, record_length: int) -> None: ...

Remarks

This method defines the length of data records to be received (in bytes) for the specified ChannelId.

If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data are received, and then it will fire the on_ssh_channel_data_in event only with data of length RecordLength. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the on_data_in event.

A value of 0 (default) means this functionality is not used.

close_channel Method

Closes a existing SSHChannel .

Syntax

def close_channel(channel_id: str) -> None: ...

Remarks

ChannelId is the identifier for the Secure Shell (SSH) channel to be closed.

config Method

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

connect Method

Connects to the Secure Shell (SSH) host without logging in.

Syntax

def connect() -> None: ...

Remarks

This method establishes a connection with the ssh_host but does not log in. In most cases, it is recommended to use the ssh_logon method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations--for instance, confirming a host is available by first creating the connection.

decode_packet Method

Decodes a hex-encoded Secure Shell (SSH) packet.

Syntax

def decode_packet(encoded_packet: str) -> bytes: ...

Remarks

This method is used to decode an SSH packet created by encode_packet.

disconnect Method

Disconnects from the server without first logging off.

Syntax

def disconnect() -> None: ...

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the ssh_logoff method should be used to log off and disconnect from the server. Call the disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

encode_packet Method

Hex encodes a Secure Shell (SSH) packet.

Syntax

def encode_packet(packet: bytes) -> str: ...

Remarks

This method is used to encode a raw SSH packet created by set_ssh_param.

exchange_keys Method

Causes the class to exchange a new set of session keys with the SSHHost .

Syntax

def exchange_keys() -> None: ...

Remarks

Secure Shell (SSH) key renegotiation can be initiated by either end of an established SSH connection. exchange_keys allows the user to start such a renegotiation with the ssh_host. During this process, on_ssh_status events will fire containing updates regarding the key negotiation process.

The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. Doing so makes it more difficult to break the security of data-intensive or long-lived connections.

get_ssh_param Method

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

def get_ssh_param(payload: bytes, field: str) -> str: ...

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as on_ssh_channel_request. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

The remaining fields that are available in the payload are dependent on the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in set_ssh_param. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

Note: The return value is a string encoded the same way as the FieldValue param in set_ssh_param.

get_ssh_param_bytes Method

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

def get_ssh_param_bytes(payload: bytes, field: str) -> bytes: ...

Remarks

This method is the same as calling get_ssh_param, but it returns raw bytes instead of strings.

open_channel Method

Opens a new SSHChannel .

Syntax

def open_channel(channel_type: str) -> str: ...

Remarks

The Secure Shell (SSH) 2.0 specification allows for multiple channels to be opened over a single Transmission Control Protocol (TCP)/IP connection. The channels property represents the channels that are currently open. A new SSHChannel can be opened with open_channel, and data can be sent over it with send_channel_data.

ChannelType represents the type of Secure Shell (SSH) channel to be opened. The most common type of channel is "session". To open a channel of type "direct-tcpip", use open_tcp_ip_channel.

If the call to open_channel succeeds, an SSHChannel will be created and added to the channels collection.

open_tcp_ip_channel Method

Opens a special Transmission Control Protocol (TCP)/IP tunneling SSHChannel .

Syntax

def open_tcp_ip_channel(dest_host: str, dest_port: int, src_host: str, src_port: int) -> str: ...

Remarks

open_tcp_ip_channel opens a special SSHChannel of type "direct-tcpip". Unlike channels opened by open_channel, "direct-tcpip" channels are secured data tunnels that forward data through the ssh_host to another destination.

DestHost and DestPort represent, respectively, the host name or IP address and the port for which the data of this channel are bound. When open_tcp_ip_channel is called, the ssh_host will attempt to connect to the machine identified by these parameters.

Likewise, SrcHost and SrcPort identify the originator of the data. These may be different from local_host and local_port if the current instance of the class is being used to forward data from another TCP/IP client.

open_terminal Method

Creates a pseudo-terminal to be used to help display data for a channel.

Syntax

def open_terminal(channel_id: str, terminal_type: str, width: int, height: int, use_pixels: bool, modes: str) -> None: ...

Remarks

open_terminal is used to establish a pseudo-terminal that will encode data sent over a "session" channel. ChannelId identifies the channel that will receive the terminal. TerminalType identifies the terminal protocol. Currently, only "vt100" is recognized by the Secure Shell (SSH) protocol specification, but other terminal types may be implemented by SSH server vendors.

Width and Height represent the size of the terminal display. If UsePixels is True, they represent the size in pixels; otherwise, they represent the size in terms of fixed-width characters.

Modes is a list of encoded terminal modes. This value must be hex encoded. For instance "350000000000" is the hex-encoded representation of the byte sequence 0x53, 0x00, 0x00, 0x00, 0x00, 0x00 (the terminal modes string to disable echo). The encoding of these modes is defined in Section 8 of the SSH Connection Specification (RFC 4254). The modes are encoded to a string as opcode-argument pairs. The opcode is always a single byte. For opcodes 1-159, the argument is a 32-bit integer. Opcodes 160-255 are currently undefined. Opcode '0' terminates the string.

Note: a string containing a single NULL byte (ie the character literal '\0') represents an empty mode list.

The following opcodes are defined:

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

send_bytes Method

Sends binary data to the specified channel.

Syntax

def send_bytes(channel_id: str, data: bytes) -> None: ...

Remarks

This method sends binary data to the channel identified by ChannelId. To send text, use the send_text method instead.

send_channel_data Method

Sends data over a Secure Shell (SSH) channel.

Syntax

def send_channel_data(channel_id: str, data: bytes) -> None: ...

Remarks

This method can be used to send arbitrary data to the channel with the specified ChannelId.

send_ssh_packet Method

Sends an encoded Secure Shell (SSH) packet to the server.

Syntax

def send_ssh_packet(channel_id: str, packet_type: int, payload: bytes) -> None: ...

Remarks

This method can be used to send a previously built SSH payload to the server. ChannelId identifies the channel that will receive the packet.

PacketType identifies what kind of packet is to be sent. Payload should contain the payload of the packet, which can be built by successive calls to set_ssh_param.

When send_ssh_packet is called, the class will finish building the packet, encrypt it for transport, and send it to the server.

send_text Method

Sends text to the specified channel.

Syntax

def send_text(channel_id: str, text: str) -> None: ...

Remarks

This method sends text to the client identified by ChannelId. To send binary data use the send_bytes method instead.

set_ssh_param Method

Writes a field to the end of a payload.

Syntax

def set_ssh_param(payload: bytes, field_type: str, field_value: str) -> bytes: ...

Remarks

This method is used to build the payload portion of a Secure Shell (SSH) packet to be sent later by a call to send_ssh_packet. Payload should contain the result of a previous call to set_ssh_param. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

Note: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

ssh_logoff Method

Logs off from the Secure Shell (SSH) server.

Syntax

def ssh_logoff() -> None: ...

Remarks

Logs off from the SSH server. If that fails, the connection is terminated by the local host.

ssh_logon Method

Logs on to the SSHHost using the current SSHUser and SSHPassword .

Syntax

def ssh_logon(ssh_host: str, ssh_port: int) -> None: ...

Remarks

Logs on to the Secure Shell (SSH) server using the current ssh_user and ssh_password. This will perform the SSH handshake and authentication.

Example. Logging On:

SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort)

start_service Method

Requests the given service on a target channel.

Syntax

def start_service(channel_id: str, service: str, parameter: str) -> None: ...

Remarks

After a "session" channel has been opened by a call to open_channel, a service may be requested for that channel. ChannelId identifies the channel on which the service is to be started.

Service identifies the service being requested. The following list defines some known services:

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

class SSHClientConnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

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

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_connection_status Event

Fired to indicate changes in the connection state.

Syntax

class SSHClientConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

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

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

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

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

on_disconnected Event

Fired when a connection is closed.

Syntax

class SSHClientDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

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

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

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_error Event

Fired when information is available about errors during data delivery.

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 on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log Event

Fired once for each log message.

Syntax

class SSHClientLogEventParams(object):
  @property
  def log_level() -> int: ...

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

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

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

Remarks

Fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

Message is the log message.

LogType is reserved for future use.

on_ssh_channel_closed Event

Fired when a channel is closed.

Syntax

class SSHClientSSHChannelClosedEventParams(object):
  @property
  def channel_id() -> str: ...

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

Remarks

The on_ssh_channel_closed event is fired when a channel is closed on a Secure Shell (SSH) connection.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_data Event

Fired when the SSHHost sends channel data to the client.

Syntax

class SSHClientSSHChannelDataEventParams(object):
  @property
  def channel_id() -> str: ...

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

  @property
  def channel_data_eol_found() -> bool: ...

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

Remarks

The on_ssh_channel_data event will fire as data are received for the given ChannelId. ChannelData will contain the decrypted contents of the Secure Shell (SSH) packet.

ChannelDataEOLFound indicates whether or not the ChannelEOL string for the channel was found at the end of ChannelData. If the ChannelEOL string was found, then ChannelDataEOLFound is True.

If ChannelData is part of a data portion of a length that is larger than the MaxChannelLength for the Channel with no ChannelEOL strings in it, then ChannelDataEOLFound is False.

Note: This means that one of more on_ssh_channel_data events with ChannelDataEOLFound set to False can be received.

If the ChannelEOL property for the Channel is "" (empty string), then ChannelDataEOLFound can be disregarded (it is always True).

on_ssh_channel_eof Event

Fired when the remote peer signals the end of the data stream for the channel.

Syntax

class SSHClientSSHChannelEOFEventParams(object):
  @property
  def channel_id() -> str: ...

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

Remarks

The on_ssh_channel_eof event is fired when the end of the data stream for a channel on a Secure Shell (SSH) connection is reached.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_opened Event

Fired when a channel is successfully opened.

Syntax

class SSHClientSSHChannelOpenedEventParams(object):
  @property
  def channel_id() -> str: ...

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

Remarks

The on_ssh_channel_opened event is fired when a channel is successfully opened on a Secure Shell (SSH) connection.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_open_request Event

Fired when a host attempts to open a new channel.

Syntax

class SSHClientSSHChannelOpenRequestEventParams(object):
  @property
  def channel_id() -> str: ...

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

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

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

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

Remarks

This event is fired whenever a host attempts to open a new channel. ChannelId will contain the Id of the channel to be created. Service will identify the type of channel that is being requested (e.g., "session"). Set Accept to True to accept the channel open request.

If the channel open request contains extra information, it will be contained in Parameters; you can extract data from it using get_ssh_param and get_ssh_param_bytes. The most common example of a request with parameters would be a request with Service set to "direct-tcpip" for Secure Shell (SSH) tunneling; in that case, Parameters will contain the host to connect (string), the port to connect (int), the originator IP address (string), and the originator Transmission Control Protocol (TCP) port (int).

on_ssh_channel_ready_to_send Event

Fired when the class is ready to send data.

Syntax

class SSHClientSSHChannelReadyToSendEventParams(object):
  @property
  def channel_id() -> str: ...

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

Remarks

This event fires when data can be sent over the Secure Shell (SSH) Channel specified by ChannelId.

When a channel is opened, this event will fire after the channel is ready and data can be sent.

When timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor on_ssh_channel_ready_to_send or ready_to_send to determine when data can be sent again.

When timeout is set to a positive value, the class will block when sending data until the data can be successfully sent and on_ssh_channel_ready_to_send and ready_to_send do not need to be monitored.

on_ssh_channel_request Event

Fired when the SSHHost sends a channel request to the client.

Syntax

class SSHClientSSHChannelRequestEventParams(object):
  @property
  def channel_id() -> str: ...

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

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

  @property
  def success() -> bool: ...
  @success.setter
  def success(value) -> None: ...

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

Remarks

The ssh_host may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. Others, however, may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types depend on the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

Success should be used to instruct the class to respond to the request with either a success or failure notification. If the request is successful, on_ssh_channel_requested will fire with the same information in case the request requires further processing.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_channel_requested Event

Fired if the SSHChannelRequest was successful; any further processing for the channel request should be done here.

Syntax

class SSHClientSSHChannelRequestedEventParams(object):
  @property
  def channel_id() -> str: ...

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

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

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

Remarks

The ssh_host may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. Others, however, may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types depend on the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

on_ssh_custom_auth Event

Fired when the class is doing a custom authentication.

Syntax

class SSHClientSSHCustomAuthEventParams(object):
  @property
  def packet() -> str: ...
  @packet.setter
  def packet(value) -> None: ...

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

Remarks

on_ssh_custom_auth is fired during the user authentication stage of the Secure Shell (SSH) logon process if ssh_auth_mode is set to amCustom. Packet contains the last raw SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet, call decode_packet and then use the get_ssh_param and get_ssh_param_bytes methods. To create a packet, use the set_ssh_param method and then call encode_packet to obtain a HEX-encoded value and assign this to the Packet parameter.

on_ssh_keyboard_interactive Event

Fired when the class receives a request for user input from the server.

Syntax

class SSHClientSSHKeyboardInteractiveEventParams(object):
  @property
  def name() -> str: ...

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

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

  @property
  def response() -> str: ...
  @response.setter
  def response(value) -> None: ...

  @property
  def echo_response() -> bool: ...

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

Remarks

on_ssh_keyboard_interactive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the class will request a list of available authentication methods for the ssh_user. For example, if the ssh_host responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: The server may send several prompts in a single packet. The class will fire the on_ssh_keyboard_interactive event once for each prompt.

on_ssh_server_authentication Event

Fired after the server presents its public key to the client.

Syntax

class SSHClientSSHServerAuthenticationEventParams(object):
  @property
  def host_key() -> bytes: ...

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

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

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

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

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

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

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

Remarks

This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (SSH) server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of ssh_accept_server_host_key.

Accept may be set to True manually to accept the server host key.

Note: SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to True is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value, see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. The following values are supported:

• ssh-rsa
• ssh-dss
• rsa-sha2-256
• rsa-sha2-512
• x509v3-sign-rsa
• x509v3-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521

CertSubject is the subject of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

on_ssh_status Event

Fired to track the progress of the secure connection.

Syntax

class SSHClientSSHStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

SSHClient Config Settings

SSHClient Config Settings

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

TCPClient Config Settings

Socket Config Settings

Base Config Settings

SSHClient Errors

SSHClient Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors