SSHAuth Class

Properties Methods Events Config Settings Errors

The SSHAuth class provides a simple way to authenticate a user against an SSH server.

Syntax

class ipworksauth.SSHAuth

Remarks

The SSHAuth class offers a simply way to authenticate a user against an SSH server.

To begin specify the ssh_host, user, and password. Next call authenticate to authenticate the user.

The class supports multiple authentication methods including public key authentication, keyboard interactive authentication, password authentication, and more. Set auth_mode to the desired authentication mechanism before calling authenticate.

Property List

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


auth_mode	The authentication method to be used with the class when calling Authenticate .
firewall_auto_detect	Whether to automatically detect and use firewall system settings, if available.
firewall_type	The type of firewall to connect through.
firewall_host	The name or IP address of the firewall (optional).
firewall_password	A password if authentication is to be used when connecting through the firewall.
firewall_port	The Transmission Control Protocol (TCP) port for the firewall Host .
firewall_user	A username if authentication is to be used when connecting through a firewall.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
local_port	The TCP port in the local host where the class binds.
password	The password for SSH password-based authentication.
ssh_accept_server_host_key_effective_date	The date on which this certificate becomes valid.
ssh_accept_server_host_key_expiration_date	The date on which the certificate expires.
ssh_accept_server_host_key_extended_key_usage	A comma-delimited list of extended key usage identifiers.
ssh_accept_server_host_key_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
ssh_accept_server_host_key_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
ssh_accept_server_host_key_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
ssh_accept_server_host_key_issuer	The issuer of the certificate.
ssh_accept_server_host_key_private_key	The private key of the certificate (if available).
ssh_accept_server_host_key_private_key_available	Whether a PrivateKey is available for the selected certificate.
ssh_accept_server_host_key_private_key_container	The name of the PrivateKey container for the certificate (if available).
ssh_accept_server_host_key_public_key	The public key of the certificate.
ssh_accept_server_host_key_public_key_algorithm	The textual description of the certificate's public key algorithm.
ssh_accept_server_host_key_public_key_length	The length of the certificate's public key (in bits).
ssh_accept_server_host_key_serial_number	The serial number of the certificate encoded as a string.
ssh_accept_server_host_key_signature_algorithm	The text description of the certificate's signature algorithm.
ssh_accept_server_host_key_store	The name of the certificate store for the client certificate.
ssh_accept_server_host_key_store_password	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	The type of certificate store for this certificate.
ssh_accept_server_host_key_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
ssh_accept_server_host_key_thumbprint_md5	The MD5 hash of the certificate.
ssh_accept_server_host_key_thumbprint_sha1	The SHA-1 hash of the certificate.
ssh_accept_server_host_key_thumbprint_sha256	The SHA-256 hash of the certificate.
ssh_accept_server_host_key_usage	The text description of UsageFlags .
ssh_accept_server_host_key_usage_flags	The flags that show intended use for the certificate.
ssh_accept_server_host_key_version	The certificate's version number.
ssh_accept_server_host_key_subject	The subject of the certificate used for client authentication.
ssh_accept_server_host_key_encoded	The certificate (PEM/Base64 encoded).
ssh_cert_effective_date	The date on which this certificate becomes valid.
ssh_cert_expiration_date	The date on which the certificate expires.
ssh_cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
ssh_cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
ssh_cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
ssh_cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
ssh_cert_issuer	The issuer of the certificate.
ssh_cert_private_key	The private key of the certificate (if available).
ssh_cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
ssh_cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
ssh_cert_public_key	The public key of the certificate.
ssh_cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
ssh_cert_public_key_length	The length of the certificate's public key (in bits).
ssh_cert_serial_number	The serial number of the certificate encoded as a string.
ssh_cert_signature_algorithm	The text description of the certificate's signature algorithm.
ssh_cert_store	The name of the certificate store for the client certificate.
ssh_cert_store_password	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	The type of certificate store for this certificate.
ssh_cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
ssh_cert_thumbprint_md5	The MD5 hash of the certificate.
ssh_cert_thumbprint_sha1	The SHA-1 hash of the certificate.
ssh_cert_thumbprint_sha256	The SHA-256 hash of the certificate.
ssh_cert_usage	The text description of UsageFlags .
ssh_cert_usage_flags	The flags that show intended use for the certificate.
ssh_cert_version	The certificate's version number.
ssh_cert_subject	The subject of the certificate used for client authentication.
ssh_cert_encoded	The certificate (PEM/Base64 encoded).
ssh_encryption_algorithms	The comma-separated list containing all allowable encryption algorithms.
ssh_host	The address of the Secure Shell (SSH) host.
ssh_port	The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.
timeout	This property includes the timeout for the class.
user	The username for SSH authentication.

Method List

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


authenticate	Authenticates the user.
config	Sets or retrieves a configuration setting.
do_events	This method processes events from the internal message queue.
interrupt	This method interrupts the current method.
reset	Resets the class.

Event List

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


on_connected	Fired immediately after a connection completes (or fails).
on_connection_status	Fired to indicate changes in the connection state.
on_disconnected	Fired when a connection is closed.
on_error	Fired when information is available about errors during data delivery.
on_log	Fired once for each log message.
on_ssh_custom_auth	Fired when the class is doing a custom authentication.
on_ssh_keyboard_interactive	Fired when the class receives a request for user input from the server.
on_ssh_server_authentication	Fired after the server presents its public key to the client.
on_ssh_status	Fired to track the progress of the secure connection.

Config Settings

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


SSHCompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
ChannelDataEOL[ChannelId]	Used to break the incoming data stream into chunks.
ChannelDataEOLFound[ChannelId]	Determines if ChannelDataEOL was found.
ClientSSHVersionString	The SSH version string used by the class.
DoNotRepeatAuthMethods	Whether the class will repeat authentication methods during multifactor authentication.
EnablePageantAuth	Whether to use a key stored in Pageant to perform client authentication.
KerberosDelegation	If true, asks for credentials with delegation enabled during authentication.
KerberosRealm	The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPN	The Kerberos Service Principal Name of the SSH host.
KeyRenegotiationThreshold	Sets the threshold for the SSH Key Renegotiation.
LogLevel	Specifies the level of detail that is logged.
MaxChannelDataLength[ChannelId]	The maximum amount of data to accumulate when no ChannelDataEOL is found.
MaxPacketSize	The maximum packet size of the channel, in bytes.
MaxWindowSize	The maximum window size allowed for the channel, in bytes.
NegotiatedStrictKex	Returns whether strict key exchange was negotiated to be used.
PasswordPrompt	The text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBits	The size (in bits) of the preferred modulus (p) to request from the server.
RecordLength	The length of received data records.
ServerSSHVersionString	The remote host's SSH version string.
SignedSSHCert	The CA signed client public key used when authenticating.
SSHAcceptAnyServerHostKey	If set the class will accept any key presented by the server.
SSHAcceptServerCAKey	The CA public key that signed the server's host key.
SSHAcceptServerHostKeyFingerPrint	The fingerprint of the server key to accept.
SSHFingerprintHashAlgorithm	The algorithm used to calculate the fingerprint.
SSHFingerprintMD5	The server hostkey's MD5 fingerprint.
SSHFingerprintSHA1	The server hostkey's SHA1 fingerprint.
SSHFingerprintSHA256	The server hostkey's SHA256 fingerprint.
SSHKeepAliveCountMax	The maximum number of keep alive packets to send without a response.
SSHKeepAliveInterval	The interval between keep alive packets.
SSHKeyExchangeAlgorithms	Specifies the supported key exchange algorithms.
SSHKeyRenegotiate	Causes the class to renegotiate the SSH keys.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithms	Specifies the enabled signature algorithms that may be used when attempting public key authentication.
SSHPublicKeyAlgorithms	Specifies the supported public key algorithms for the server's public key.
SSHVersionPattern	The pattern used to match the remote host's version string.
TryAllAvailableAuthMethods	If set to true, the class will try all available authentication methods.
UseStrictKeyExchange	Specifies how strict key exchange is supported.
WaitForChannelClose	Whether to wait for channels to be closed before disconnected.
WaitForServerDisconnect	Whether to wait for the server to close the connection.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

auth_mode Property

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

Syntax

def get_auth_mode() -> int: ...
def set_auth_mode(value: int) -> None: ...

auth_mode = property(get_auth_mode, set_auth_mode)

Default Value

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 authenticate, 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 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 auth_mode and other property values supplied by the user. Currently, the class supports the following authentication methods:


`amNone` (0)	No authentication will be performed. The current user value is ignored, and the connection will be logged as anonymous.
`amMultiFactor` (1)	This allows the class to attempt a multistep authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error.
`amPassword` (2)	The class will use the values of user and password to authenticate the user.
`amPublicKey` (3)	The class will use the values of user and the ssh_cert* properties to authenticate the user. the ssh_cert* properties must have a private key available for this authentication method to succeed.
`amKeyboardInteractive` (4)	At the time of authentication, the class will fire the on_ssh_keyboard_interactive event containing instructions on how to complete the authentication step. Note: `amKeyboardInteractive` is not supported in SSHTunnel.
`amGSSAPIWithMic` (5)	This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of user (single sign-on), or if password is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS.
`amGSSAPIKeyex` (6)	This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of user (single sign-on), or if password is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS.
`amCustom` (99)	This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the on_ssh_custom_auth event as necessary to complete the authentication process.

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

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

Remarks

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


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. firewall_port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. firewall_port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. firewall_port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. firewall_port is set to 1080.

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

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

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.

password Property

The password for SSH password-based authentication.

Syntax

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

password = property(get_password, set_password)

Default Value

Remarks

Password specifies the password which is used to authenticate the client to the SSH server.

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

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:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

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

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:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssh_accept_server_host_key_store and set ssh_accept_server_host_key_store_password to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

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

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:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the ssh_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:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

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

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

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

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

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:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

Remarks

The type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssh_cert_store and set ssh_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

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

Remarks

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


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the ssh_cert_usage 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.

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.


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

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


`aes256-ctr`	256-bit AES encryption in CTR mode.
`aes256-cbc`	256-bit AES encryption in CBC mode.
`aes192-ctr`	192-bit AES encryption in CTR mode.
`aes192-cbc`	192-bit AES encryption in CBC mode.
`aes128-ctr`	128-bit AES encryption in CTR mode.
`aes128-cbc`	128-bit AES encryption in CBC mode.
`3des-ctr`	192-bit (3-key) triple DES encryption in CTR mode.
`3des-cbc`	192-bit (3-key) triple DES encryption in CBC mode.
`cast128-cbc`	CAST-128 encryption.
`blowfish-cbc`	Blowfish encryption.
`arcfour`	ARC4 encryption.
`arcfour128`	128-bit ARC4 encryption.
`arcfour256`	256-bit ARC4 encryption.
`aes256-gcm@openssh.com`	256-bit AES encryption in GCM mode.
`aes128-gcm@openssh.com`	128-bit AES encryption in GCM mode.
`chacha20-poly1305@openssh.com`	ChaCha20 with Poly1305-AES encryption.

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

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.

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

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.

user Property

The username for SSH authentication.

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

Remarks

User specifies the username which is used to authenticate the client to the SSH server. This property is required.

authenticate Method

Authenticates the user.

Syntax

def authenticate() -> None: ...

Remarks

This method authenticates the user against the ssh_host. If authentication succeeds this method returns without error. If authentication fails, or an error is encountered, the class fails with an error.

The following common properties are applicable when calling this method:

user (required)
password (required for password authentication)
ssh_cert (required for public key authentication)
ssh_host (required)
ssh_port
auth_mode
ssh_encryption_algorithms

Keyboard interactive authentication is handled through the on_ssh_keyboard_interactive event.

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.

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.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

When called, the class will reset all of its properties to their default values.

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

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

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

# In class SSHAuth:
@property
def on_connected() -> Callable[[SSHAuthConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[SSHAuthConnectedEventParams], 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 SSHAuthConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

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

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

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


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

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.

on_disconnected Event

Fired when a connection is closed.

Syntax

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

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

# In class SSHAuth:
@property
def on_disconnected() -> Callable[[SSHAuthDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[SSHAuthDisconnectedEventParams], 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 SSHAuthErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class SSHAuth:
@property
def on_error() -> Callable[[SSHAuthErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SSHAuthErrorEventParams], 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 SSHAuthLogEventParams(object):
  @property
  def log_level() -> int: ...

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

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

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


0 (None)	No messages are logged.
1 (Info - Default)	Informational events such as Secure Shell (SSH) handshake messages are logged.
2 (Verbose)	Detailed data such as individual packet information are logged.
3 (Debug)	Debug data including all relevant sent and received bytes are logged.

Message is the log message.

LogType is reserved for future use.

on_ssh_custom_auth Event

Fired when the class is doing a custom authentication.

Syntax

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

# In class SSHAuth:
@property
def on_ssh_custom_auth() -> Callable[[SSHAuthSSHCustomAuthEventParams], None]: ...
@on_ssh_custom_auth.setter
def on_ssh_custom_auth(event_hook: Callable[[SSHAuthSSHCustomAuthEventParams], 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 SSHAuthSSHKeyboardInteractiveEventParams(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 SSHAuth:
@property
def on_ssh_keyboard_interactive() -> Callable[[SSHAuthSSHKeyboardInteractiveEventParams], None]: ...
@on_ssh_keyboard_interactive.setter
def on_ssh_keyboard_interactive(event_hook: Callable[[SSHAuthSSHKeyboardInteractiveEventParams], 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 SSHAuthSSHServerAuthenticationEventParams(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 SSHAuth:
@property
def on_ssh_server_authentication() -> Callable[[SSHAuthSSHServerAuthenticationEventParams], None]: ...
@on_ssh_server_authentication.setter
def on_ssh_server_authentication(event_hook: Callable[[SSHAuthSSHServerAuthenticationEventParams], 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

To limit the accepted host key algorithms, refer to SSHPublicKeyAlgorithms.

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 SSHAuthSSHStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

SSHAuth Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

SSHAuth Config Settings

SSHCompressionAlgorithms: A comma-separated list containing all allowable compression algorithms.

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

SSHClient Config Settings

ChannelDataEOL[ChannelId]: Used to break the incoming data stream into chunks.

By default MaxChannelDataLength is 0 and ChannelDataEOL is an empty string. on_ssh_channel_data fires whenever an SSH_MSG_CHANNEL_DATA packet is received.

If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire on_ssh_channel_data until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time on_ssh_channel_data fires.

ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.

ChannelDataEOLFound[ChannelId]: Determines if ChannelDataEOL was found.

If True,then ChannelDataEOL was found. If False, then MaxChannelDataLength was reached.

This configuration setting is valid only when queried inside on_ssh_channel_data, MaxChannelDataLength > 0, and ChannelDataEOL is nonempty.

ClientSSHVersionString: The SSH version string used by the class.

This configuration setting specifies the Secure Shell (SSH) version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2024".

Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.

DoNotRepeatAuthMethods: Whether the class will repeat authentication methods during multifactor authentication.

The default value is True. When set to False, the class will repeat authentication methods that have already been completed during multifactor authentication.

EnablePageantAuth: Whether to use a key stored in Pageant to perform client authentication.

This configuration setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the class attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described as follows:


Value	Description
0 (Disabled - default)	No communication with Pageant is attempted.
1 (Enabled)	Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key, no error is thrown.
2 (Required)	Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key, an error is thrown.

Example 1. Enabling Pageant: component.Config("EnablePageantAuth=1"); component.SSHUser = "sshuser"; component.SSHLogon("localhost", 22);

Note: This functionality is available only on Windows.

KerberosDelegation: If true, asks for credentials with delegation enabled during authentication.

The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication.

Note: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed.

KerberosRealm: The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.

This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain.

KerberosSPN: The Kerberos Service Principal Name of the SSH host.

This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the class will assume the SPN is based on the value of the ssh_host property and the kerberos realm used for authentication.

KeyRenegotiationThreshold: Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the Secure Shell (SSH) key renegotiation. The default value for this property is set to 1 GB.

Example. Setting the Threshold to 500 MB: SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogLevel: Specifies the level of detail that is logged.

This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows:


0 (None)	No messages are logged.
1 (Info - Default)	Informational events such as Secure Shell (SSH) handshake messages are logged.
2 (Verbose)	Detailed data such as individual packet information are logged.
3 (Debug)	Debug data including all relevant sent and received bytes are logged.

MaxChannelDataLength[ChannelId]: The maximum amount of data to accumulate when no ChannelDataEOL is found.

By default MaxChannelDataLength is 0 and ChannelDataEOL is an empty string. on_ssh_channel_data fires whenever an SSH_MSG_CHANNEL_DATA packet is received.

ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.

MaxPacketSize: The maximum packet size of the channel, in bytes.

This configuration setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender.

MaxWindowSize: The maximum window size allowed for the channel, in bytes.

This configuration setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window.

Note: This value may be changed during the connection, but the window size can only be increased, not decreased.

NegotiatedStrictKex: Returns whether strict key exchange was negotiated to be used.

This configuration setting specifies whether strict key exchange (strict kex) was negotiated during the SSH handshake. If strict kex is being used, then this will return "True". If strict kex is not being used, then this will return "False".

component.Config("NegotiatedStrictKex")

PasswordPrompt: The text of the password prompt used in keyboard-interactive authentication.

This configuration setting optionally specifies a pattern to be matched to the prompt received from the server during keyboard-interactive authentication. If a matching prompt is detected the class automatically responds to the prompt with the password specified by ssh_password.

This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be autofilled in the Response parameter of the on_ssh_keyboard_interactive event in the case of a match.

The following special characters are supported for pattern matching:


?	Any single character.
*	Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-]	A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\	The slash is ignored and exact matching is performed on the next character.

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:


Character	Escape Sequence
?	[?]
*	[*]
[	[[]
\	[\]

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

PreferredDHGroupBits: The size (in bits) of the preferred modulus (p) to request from the server.

This configuration setting may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192.

RecordLength: The length of received data records.

If set to a positive value, this configuration setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then will it fire the on_data_in event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the on_data_in event.

The default value is 0, meaning this setting is not used.

ServerSSHVersionString: The remote host's SSH version string.

This configuration setting will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only.

SignedSSHCert: The CA signed client public key used when authenticating.

When authenticating via public key authentication, this setting may be set to the certificate authority (CA) signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB..."); The algorithm such as ssh-rsa-cert-v01@openssh.com in the previous string is used as part of the authentication process. To use a different algorithm, simply change this value. For instance, all of the following are acceptable with the same signed public key:

ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...

SSHAcceptAnyServerHostKey: If set the class will accept any key presented by the server.

The default value is "False". Set this to "True" to accept any key presented by the server.

SSHAcceptServerCAKey: The CA public key that signed the server's host key.

If the server's host key was signed by a CA, this configuration setting may be used to specify the CA's public key. If specified, the class will trust any server's host key that was signed by the CA. For instance: component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");

SSHAcceptServerHostKeyFingerPrint: The fingerprint of the server key to accept.

This configuration setting may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by hex- encoding the values in the form "0a:1b:2c:3d". Example 2. Accepting Fingerprints: SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d"); If the server's fingerprint matches one of the values supplied, the class will accept the host key.

SSHFingerprintHashAlgorithm: The algorithm used to calculate the fingerprint.

This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when on_ssh_server_authentication fires. Valid values are as follows:

MD5
SHA1
SHA256 (default)

SSHFingerprintMD5: The server hostkey's MD5 fingerprint.

This configuration setting may be queried in on_ssh_server_authentication to get the server hostkey's MD5 fingerprint.

SSHFingerprintSHA1: The server hostkey's SHA1 fingerprint.

This configuration setting may be queried in on_ssh_server_authentication to get the server hostkey's SHA-1 fingerprint.

SSHFingerprintSHA256: The server hostkey's SHA256 fingerprint.

This configuration setting may be queried in on_ssh_server_authentication to get the server hostkey's SHA-256 fingerprint.

SSHKeepAliveCountMax: The maximum number of keep alive packets to send without a response.

This configuration setting specifies the maximum number of keep-alive packets to send when no response is received. Normally a response to a keep-alive packet is received right away. If no response is received, the class will continue to send keep-alive packets until SSHKeepAliveCountMax is reached. If this is reached, the class will assume the connection is broken and disconnect. The default value is 5.

SSHKeepAliveInterval: The interval between keep alive packets.

This configuration setting specifies the number of seconds between keep alive packets. If set to a positive value, the class will send a SSH keep-alive packet after KeepAliveInterval seconds of inactivity. This configuration setting takes effect only when there is no activity; if any data are sent or received over the connection, it will reset the timer.

The default value is 0, meaning no keep alives will be sent.

Note: The SSHREVERSETUNNEL class uses a default value of 30.

SSHKeyExchangeAlgorithms: Specifies the supported key exchange algorithms.

This configuration setting may be used to specify the list of supported key exchange algorithms used during Secure Shell (SSH) negotiation. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows:

curve25519-sha256
curve25519-sha256@libssh.org
diffie-hellman-group1-sha1
diffie-hellman-group14-sha1
diffie-hellman-group14-sha256
diffie-hellman-group16-sha512
diffie-hellman-group18-sha512
diffie-hellman-group-exchange-sha256
diffie-hellman-group-exchange-sha1
ecdh-sha2-nistp256
ecdh-sha2-nistp384
ecdh-sha2-nistp521
gss-group14-sha256-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==

The default value is curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,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==.

SSHKeyRenegotiate: Causes the component to renegotiate the SSH keys.

Once this configuration setting is queried, the component will renegotiate the SSH keys with the remote host.

Example 3. Renegotiating SSH Keys: SSHClient.Config("SSHKeyRenegotiate")

SSHMacAlgorithms: Specifies the supported Mac algorithms.

This configuration setting may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows:

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

The default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com.

SSHPubKeyAuthSigAlgorithms: Specifies the enabled signature algorithms that may be used when attempting public key authentication.

This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

The setting should be a comma-separated list of algorithms. At runtime, the class will evaluate the specified algorithms, and if the algorithm is applicable to the certificate specified in ssh_cert, it will be used. If the algorithm is not applicable, the class will evaluate the next algorithm. Possible values are as follows:

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

The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.

rsa-sha2-256 and rsa-sha2-512 notes

The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.

For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred, the server must support the ext-info-c mechanism. In practice, older servers do not support this, and in that case, ssh-rsa will be used because it appears first in the list. Newer servers do support this mechanism, and in that case, rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.

This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers that support them.

SSHPublicKeyAlgorithms: Specifies the supported public key algorithms for the server's public key.

This configuration setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

SSHVersionPattern: The pattern used to match the remote host's version string.

This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the following value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.

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

TryAllAvailableAuthMethods: If set to true, the class will try all available authentication methods.

The default value is False. When set to True, the class will try to authenticate using all methods that it has credentials for and the server supports.

UseStrictKeyExchange: Specifies how strict key exchange is supported.

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

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


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

WaitForChannelClose: Whether to wait for channels to be closed before disconnected.

This configuration setting controls whether the class will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the class disconnects, it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This configuration setting controls whether the class will wait for a server response after sending the messages.

When True (default), the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or timeout seconds is reached.

When False, the class will still send the channel close messages, but it will not wait for a response and will proceed to close the connection.

WaitForServerDisconnect: Whether to wait for the server to close the connection.

This configuration setting controls whether to wait for the server to close the connection when ssh_logoff is called.

When set to True, the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT, but it will not close the connection and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances in which many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.

When set to False (default), the client will close the connection. It is recommended to use this value unless there is a specific need to change it.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The local_host setting 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 value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host setting 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).

LocalPort: The port in the local host where the class binds.

This configuration setting 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 to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

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

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI: Tells the class whether or not to use FIPS certified APIs.

When set to True, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

Note: This setting is applicable only on Windows.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

SSHAuth Errors

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

TCPClient Errors

100	You cannot change the remote_port at this time. A connection is in progress.
101	You cannot change the remote_host (Server) at this time. A connection is in progress.
102	The remote_host address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the local_port at this time. A connection is in progress.
107	You cannot change the local_host at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	remote_port cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the class is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
302	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).