SSHAuth Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorksAuth.SSHAuth

Remarks

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

To begin specify the SSHHost, 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 AuthMode to the desired authentication mechanism before calling Authenticate.

Property List

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

AuthModeThe authentication method to be used with the module when calling Authenticate .
FirewallA set of properties related to firewall access.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the module binds.
PasswordThe password for SSH password-based authentication.
SSHAcceptServerHostKeyInstructs the module to accept the server host key that matches the supplied key.
SSHCertA certificate to be used for authenticating the SSHUser .
SSHEncryptionAlgorithmsThe comma-separated list containing all allowable encryption algorithms.
SSHHostThe address of the Secure Shell (SSH) host.
SSHPortThe port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.
TimeoutThis property includes the timeout for the module.
UserThe username for SSH authentication.

Method List

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

AuthenticateAuthenticates the user.
ConfigSets or retrieves a configuration setting.
DoEventsThis method processes events from the internal message queue.
InterruptThis method interrupts the current method.
ResetResets the module.

Event List

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

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in the connection state.
DisconnectedFired when a connection is closed.
ErrorFired when information is available about errors during data delivery.
LogFired once for each log message.
SSHCustomAuthFired when the module is doing a custom authentication.
SSHKeyboardInteractiveFired when the module receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusFired to track the progress of the secure connection.

Config Settings

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

SSHCompressionAlgorithmsA 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.
ClientSSHVersionStringThe SSH version string used by the module.
DoNotRepeatAuthMethodsWhether the module will repeat authentication methods during multifactor authentication.
EnablePageantAuthWhether to use a key stored in Pageant to perform client authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogLevelSpecifies the level of detail that is logged.
MaxChannelDataLength[ChannelId]The maximum amount of data to accumulate when no ChannelDataEOL is found.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
NegotiatedStrictKexReturns whether strict key exchange was negotiated to be used.
PasswordPromptThe text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
RecordLengthThe length of received data records.
ServerSSHVersionStringThe remote host's SSH version string.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptAnyServerHostKeyIf set the module will accept any key presented by the server.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHFingerprintHashAlgorithmThe algorithm used to calculate the fingerprint.
SSHFingerprintMD5The server hostkey's MD5 fingerprint.
SSHFingerprintSHA1The server hostkey's SHA1 fingerprint.
SSHFingerprintSHA256The server hostkey's SHA256 fingerprint.
SSHKeepAliveCountMaxThe maximum number of keep alive packets to send without a response.
SSHKeepAliveIntervalThe interval between keep alive packets.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHKeyRenegotiateCauses the module to renegotiate the SSH keys.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the enabled signature algorithms that may be used when attempting public key authentication.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms for the server's public key.
SSHVersionPatternThe pattern used to match the remote host's version string.
TryAllAvailableAuthMethodsIf set to true, the module will try all available authentication methods.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
WaitForChannelCloseWhether to wait for channels to be closed before disconnected.
WaitForServerDisconnectWhether to wait for the server to close the connection.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AuthMode Property (SSHAuth Module)

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

Syntax

public var authMode: SSHAuthAuthModes {
  get {...}
  set {...}
}

public enum SSHAuthAuthModes: Int32 {
  case amNone = 0
  case amMultiFactor = 1
  case amPassword = 2
  case amPublicKey = 3
  case amKeyboardInteractive = 4
  case amGSSAPIWithMic = 5
  case amCustom = 6
}


@property (nonatomic,readwrite,assign,getter=authMode,setter=setAuthMode:) int authMode;

- (int)authMode;
- (void)setAuthMode :(int)newAuthMode;

Default Value

2

Remarks

The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to 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 SSHHost 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 AuthMode 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 .
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 SSHCert* properties to authenticate the user. the SSHCert* 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 SSHKeyboardInteractive 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 SSHCustomAuth 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 Property (SSHAuth Module)

A set of properties related to firewall access.

Syntax

public var firewall: Firewall {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

Default Value

""

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

LocalHost Property (SSHAuth Module)

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

Syntax

public var localHost: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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 LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (SSHAuth Module)

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

Syntax

public var localPort: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

Default Value

0

Remarks

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

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

LocalPort 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 (SSHAuth Module)

The password for SSH password-based authentication.

Syntax

public var password: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

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

SSHAcceptServerHostKey Property (SSHAuth Module)

Instructs the module to accept the server host key that matches the supplied key.

Syntax

public var sshAcceptServerHostKey: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyEffectiveDate) NSString* SSHAcceptServerHostKeyEffectiveDate;

- (NSString*)SSHAcceptServerHostKeyEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyExpirationDate) NSString* SSHAcceptServerHostKeyExpirationDate;

- (NSString*)SSHAcceptServerHostKeyExpirationDate;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyExtendedKeyUsage) NSString* SSHAcceptServerHostKeyExtendedKeyUsage;

- (NSString*)SSHAcceptServerHostKeyExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyFingerprint) NSString* SSHAcceptServerHostKeyFingerprint;

- (NSString*)SSHAcceptServerHostKeyFingerprint;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyFingerprintSHA1) NSString* SSHAcceptServerHostKeyFingerprintSHA1;

- (NSString*)SSHAcceptServerHostKeyFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyFingerprintSHA256) NSString* SSHAcceptServerHostKeyFingerprintSHA256;

- (NSString*)SSHAcceptServerHostKeyFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyIssuer) NSString* SSHAcceptServerHostKeyIssuer;

- (NSString*)SSHAcceptServerHostKeyIssuer;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPrivateKey) NSString* SSHAcceptServerHostKeyPrivateKey;

- (NSString*)SSHAcceptServerHostKeyPrivateKey;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPrivateKeyAvailable) BOOL SSHAcceptServerHostKeyPrivateKeyAvailable;

- (BOOL)SSHAcceptServerHostKeyPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPrivateKeyContainer) NSString* SSHAcceptServerHostKeyPrivateKeyContainer;

- (NSString*)SSHAcceptServerHostKeyPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPublicKey) NSString* SSHAcceptServerHostKeyPublicKey;

- (NSString*)SSHAcceptServerHostKeyPublicKey;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPublicKeyAlgorithm) NSString* SSHAcceptServerHostKeyPublicKeyAlgorithm;

- (NSString*)SSHAcceptServerHostKeyPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyPublicKeyLength) int SSHAcceptServerHostKeyPublicKeyLength;

- (int)SSHAcceptServerHostKeyPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeySerialNumber) NSString* SSHAcceptServerHostKeySerialNumber;

- (NSString*)SSHAcceptServerHostKeySerialNumber;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeySignatureAlgorithm) NSString* SSHAcceptServerHostKeySignatureAlgorithm;

- (NSString*)SSHAcceptServerHostKeySignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStore,setter=setSSHAcceptServerHostKeyStore:) NSString* SSHAcceptServerHostKeyStore;

- (NSString*)SSHAcceptServerHostKeyStore;
- (void)setSSHAcceptServerHostKeyStore :(NSString*)newSSHAcceptServerHostKeyStore;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStoreB,setter=setSSHAcceptServerHostKeyStoreB:) NSData* SSHAcceptServerHostKeyStoreB;

- (NSData*)SSHAcceptServerHostKeyStoreB;
- (void)setSSHAcceptServerHostKeyStoreB :(NSData*)newSSHAcceptServerHostKeyStore;
@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStorePassword,setter=setSSHAcceptServerHostKeyStorePassword:) NSString* SSHAcceptServerHostKeyStorePassword;

- (NSString*)SSHAcceptServerHostKeyStorePassword;
- (void)setSSHAcceptServerHostKeyStorePassword :(NSString*)newSSHAcceptServerHostKeyStorePassword;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyStoreType,setter=setSSHAcceptServerHostKeyStoreType:) int SSHAcceptServerHostKeyStoreType;

- (int)SSHAcceptServerHostKeyStoreType;
- (void)setSSHAcceptServerHostKeyStoreType :(int)newSSHAcceptServerHostKeyStoreType;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeySubjectAltNames) NSString* SSHAcceptServerHostKeySubjectAltNames;

- (NSString*)SSHAcceptServerHostKeySubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyThumbprintMD5) NSString* SSHAcceptServerHostKeyThumbprintMD5;

- (NSString*)SSHAcceptServerHostKeyThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyThumbprintSHA1) NSString* SSHAcceptServerHostKeyThumbprintSHA1;

- (NSString*)SSHAcceptServerHostKeyThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyThumbprintSHA256) NSString* SSHAcceptServerHostKeyThumbprintSHA256;

- (NSString*)SSHAcceptServerHostKeyThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyUsage) NSString* SSHAcceptServerHostKeyUsage;

- (NSString*)SSHAcceptServerHostKeyUsage;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyUsageFlags) int SSHAcceptServerHostKeyUsageFlags;

- (int)SSHAcceptServerHostKeyUsageFlags;

@property (nonatomic,readonly,assign,getter=SSHAcceptServerHostKeyVersion) NSString* SSHAcceptServerHostKeyVersion;

- (NSString*)SSHAcceptServerHostKeyVersion;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeySubject,setter=setSSHAcceptServerHostKeySubject:) NSString* SSHAcceptServerHostKeySubject;

- (NSString*)SSHAcceptServerHostKeySubject;
- (void)setSSHAcceptServerHostKeySubject :(NSString*)newSSHAcceptServerHostKeySubject;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyEncoded,setter=setSSHAcceptServerHostKeyEncoded:) NSString* SSHAcceptServerHostKeyEncoded;

- (NSString*)SSHAcceptServerHostKeyEncoded;
- (void)setSSHAcceptServerHostKeyEncoded :(NSString*)newSSHAcceptServerHostKeyEncoded;

@property (nonatomic,readwrite,assign,getter=SSHAcceptServerHostKeyEncodedB,setter=setSSHAcceptServerHostKeyEncodedB:) NSData* SSHAcceptServerHostKeyEncodedB;

- (NSData*)SSHAcceptServerHostKeyEncodedB;
- (void)setSSHAcceptServerHostKeyEncodedB :(NSData*)newSSHAcceptServerHostKeyEncoded;

Default Value

""

Remarks

If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. Otherwise, the SSHServerAuthentication event should be trapped, and the key should be accepted or refused in the event.

If this property is not set and the SSHServerAuthentication event is not trapped, the server will not be authenticated and the connection will be terminated by the client.

SSHCert Property (SSHAuth Module)

A certificate to be used for authenticating the SSHUser .

Syntax

public var sshCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSHCertEffectiveDate) NSString* SSHCertEffectiveDate;

- (NSString*)SSHCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSHCertExpirationDate) NSString* SSHCertExpirationDate;

- (NSString*)SSHCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSHCertExtendedKeyUsage) NSString* SSHCertExtendedKeyUsage;

- (NSString*)SSHCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSHCertFingerprint) NSString* SSHCertFingerprint;

- (NSString*)SSHCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSHCertFingerprintSHA1) NSString* SSHCertFingerprintSHA1;

- (NSString*)SSHCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHCertFingerprintSHA256) NSString* SSHCertFingerprintSHA256;

- (NSString*)SSHCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHCertIssuer) NSString* SSHCertIssuer;

- (NSString*)SSHCertIssuer;

@property (nonatomic,readonly,assign,getter=SSHCertPrivateKey) NSString* SSHCertPrivateKey;

- (NSString*)SSHCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSHCertPrivateKeyAvailable) BOOL SSHCertPrivateKeyAvailable;

- (BOOL)SSHCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSHCertPrivateKeyContainer) NSString* SSHCertPrivateKeyContainer;

- (NSString*)SSHCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSHCertPublicKey) NSString* SSHCertPublicKey;

- (NSString*)SSHCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSHCertPublicKeyAlgorithm) NSString* SSHCertPublicKeyAlgorithm;

- (NSString*)SSHCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSHCertPublicKeyLength) int SSHCertPublicKeyLength;

- (int)SSHCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSHCertSerialNumber) NSString* SSHCertSerialNumber;

- (NSString*)SSHCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSHCertSignatureAlgorithm) NSString* SSHCertSignatureAlgorithm;

- (NSString*)SSHCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSHCertStore,setter=setSSHCertStore:) NSString* SSHCertStore;

- (NSString*)SSHCertStore;
- (void)setSSHCertStore :(NSString*)newSSHCertStore;

@property (nonatomic,readwrite,assign,getter=SSHCertStoreB,setter=setSSHCertStoreB:) NSData* SSHCertStoreB;

- (NSData*)SSHCertStoreB;
- (void)setSSHCertStoreB :(NSData*)newSSHCertStore;
@property (nonatomic,readwrite,assign,getter=SSHCertStorePassword,setter=setSSHCertStorePassword:) NSString* SSHCertStorePassword;

- (NSString*)SSHCertStorePassword;
- (void)setSSHCertStorePassword :(NSString*)newSSHCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSHCertStoreType,setter=setSSHCertStoreType:) int SSHCertStoreType;

- (int)SSHCertStoreType;
- (void)setSSHCertStoreType :(int)newSSHCertStoreType;

@property (nonatomic,readonly,assign,getter=SSHCertSubjectAltNames) NSString* SSHCertSubjectAltNames;

- (NSString*)SSHCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSHCertThumbprintMD5) NSString* SSHCertThumbprintMD5;

- (NSString*)SSHCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSHCertThumbprintSHA1) NSString* SSHCertThumbprintSHA1;

- (NSString*)SSHCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSHCertThumbprintSHA256) NSString* SSHCertThumbprintSHA256;

- (NSString*)SSHCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSHCertUsage) NSString* SSHCertUsage;

- (NSString*)SSHCertUsage;

@property (nonatomic,readonly,assign,getter=SSHCertUsageFlags) int SSHCertUsageFlags;

- (int)SSHCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSHCertVersion) NSString* SSHCertVersion;

- (NSString*)SSHCertVersion;

@property (nonatomic,readwrite,assign,getter=SSHCertSubject,setter=setSSHCertSubject:) NSString* SSHCertSubject;

- (NSString*)SSHCertSubject;
- (void)setSSHCertSubject :(NSString*)newSSHCertSubject;

@property (nonatomic,readwrite,assign,getter=SSHCertEncoded,setter=setSSHCertEncoded:) NSString* SSHCertEncoded;

- (NSString*)SSHCertEncoded;
- (void)setSSHCertEncoded :(NSString*)newSSHCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSHCertEncodedB,setter=setSSHCertEncodedB:) NSData* SSHCertEncodedB;

- (NSData*)SSHCertEncodedB;
- (void)setSSHCertEncodedB :(NSData*)newSSHCertEncoded;

Default Value

""

Remarks

To use public key authentication, SSHCert must contain a Certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user, and then it will attempt to use those values to verify the signature.

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)

SSHEncryptionAlgorithms Property (SSHAuth Module)

The comma-separated list containing all allowable encryption algorithms.

Syntax

public var sshEncryptionAlgorithms: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSHEncryptionAlgorithms,setter=setSSHEncryptionAlgorithms:) NSString* SSHEncryptionAlgorithms;

- (NSString*)SSHEncryptionAlgorithms;
- (void)setSSHEncryptionAlgorithms :(NSString*)newSSHEncryptionAlgorithms;

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-ctr256-bit AES encryption in CTR mode.
aes256-cbc256-bit AES encryption in CBC mode.
aes192-ctr192-bit AES encryption in CTR mode.
aes192-cbc192-bit AES encryption in CBC mode.
aes128-ctr128-bit AES encryption in CTR mode.
aes128-cbc128-bit AES encryption in CBC mode.
3des-ctr192-bit (3-key) triple DES encryption in CTR mode.
3des-cbc192-bit (3-key) triple DES encryption in CBC mode.
cast128-cbcCAST-128 encryption.
blowfish-cbcBlowfish encryption.
arcfourARC4 encryption.
arcfour128128-bit ARC4 encryption.
arcfour256256-bit ARC4 encryption.
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-bit AES encryption in GCM mode.
chacha20-poly1305@openssh.comChaCha20 with Poly1305-AES encryption.

SSHHost Property (SSHAuth Module)

The address of the Secure Shell (SSH) host.

Syntax

public var sshHost: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSHHost,setter=setSSHHost:) NSString* SSHHost;

- (NSString*)SSHHost;
- (void)setSSHHost :(NSString*)newSSHHost;

Default Value

""

Remarks

The SSHHost 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 SSHHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

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

SSHPort Property (SSHAuth Module)

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

Syntax

public var sshPort: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSHPort,setter=setSSHPort:) int SSHPort;

- (int)SSHPort;
- (void)setSSHPort :(int)newSSHPort;

Default Value

22

Remarks

The SSHPort 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 (SSHAuth Module)

This property includes the timeout for the module.

Syntax

public var timeout: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

60

Remarks

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

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

The class will use DoEvents 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 .

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 (SSHAuth Module)

The username for SSH authentication.

Syntax

public var user: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

Default Value

""

Remarks

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

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)

Authenticate Method (SSHAuth Module)

Authenticates the user.

Syntax

public func authenticate() throws -> Void

- (void)authenticate;

Remarks

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

The following common properties are applicable when calling this method:

Keyboard interactive authentication is handled through the SSHKeyboardInteractive event.

Config Method (SSHAuth Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

DoEvents Method (SSHAuth Module)

This method processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

When DoEvents 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 (SSHAuth Module)

This method interrupts the current method.

Syntax

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (SSHAuth Module)

Resets the component.

Syntax

public func reset() throws -> Void

- (void)reset;

Remarks

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

Connected Event (SSHAuth Module)

Fired immediately after a connection completes (or fails).

Syntax

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

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.

ConnectionStatus Event (SSHAuth Module)

Fired to indicate changes in the connection state.

Syntax

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

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.

Disconnected Event (SSHAuth Module)

Fired when a connection is closed.

Syntax

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

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.

Error Event (SSHAuth Module)

Fired when information is available about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

Log Event (SSHAuth Module)

Fired once for each log message.

Syntax

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

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.

SSHCustomAuth Event (SSHAuth Module)

Fired when the component is doing a custom authentication.

Syntax

func onSSHCustomAuth(packet: inout String)

- (void)onSSHCustomAuth:(NSString**)packet;

Remarks

SSHCustomAuth is fired during the user authentication stage of the Secure Shell (SSH) logon process if SSHAuthMode 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 DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet, use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SSHAuth Module)

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

Syntax

func onSSHKeyboardInteractive(name: String, instructions: String, prompt: String, response: inout String, echoResponse: Bool)

- (void)onSSHKeyboardInteractive:(NSString*)name :(NSString*)instructions :(NSString*)prompt :(NSString**)response :(BOOL)echoResponse;

Remarks

SSHKeyboardInteractive 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 SSHUser. For example, if the SSHHost 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 SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SSHAuth Module)

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

Syntax

func onSSHServerAuthentication(hostKey: Data, fingerprint: String, keyAlgorithm: String, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSHServerAuthentication:(NSData*)hostKey :(NSString*)fingerprint :(NSString*)keyAlgorithm :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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

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.

SSHStatus Event (SSHAuth Module)

Fired to track the progress of the secure connection.

Syntax

func onSSHStatus(message: String)

- (void)onSSHStatus:(NSString*)message;

Remarks

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

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:
  • EffectiveDate
  • ExpirationDate
  • ExtendedKeyUsage
  • Fingerprint
  • FingerprintSHA1
  • FingerprintSHA256
  • Issuer
  • PrivateKey
  • PrivateKeyAvailable
  • PrivateKeyContainer
  • PublicKey
  • PublicKeyAlgorithm
  • PublicKeyLength
  • SerialNumber
  • SignatureAlgorithm
  • Store
  • StorePassword
  • StoreType
  • SubjectAltNames
  • ThumbprintMD5
  • ThumbprintSHA1
  • ThumbprintSHA256
  • Usage
  • UsageFlags
  • Version
  • Subject
  • Encoded

    • Fields

    effectiveDate
    String (read-only)
    Default Value: ""

    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.

    expirationDate
    String (read-only)
    Default Value: ""

    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.

    extendedKeyUsage
    String (read-only)
    Default Value: ""

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

    fingerprint
    String (read-only)
    Default Value: ""

    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

    fingerprintSHA1
    String (read-only)
    Default Value: ""

    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

    fingerprintSHA256
    String (read-only)
    Default Value: ""

    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

    issuer
    String (read-only)
    Default Value: ""

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

    privateKey
    String (read-only)
    Default Value: ""

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

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

    privateKeyAvailable
    Bool (read-only)
    Default Value: False

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

    privateKeyContainer
    String (read-only)
    Default Value: ""

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

    publicKey
    String (read-only)
    Default Value: ""

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

    publicKeyAlgorithm
    String (read-only)
    Default Value: ""

    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.

    publicKeyLength
    Int32 (read-only)
    Default Value: 0

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

    serialNumber
    String (read-only)
    Default Value: ""

    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.

    signatureAlgorithm
    String (read-only)
    Default Value: ""

    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.

    storeB
    Data
    Default Value: "MY"

    The name of the certificate store for the client certificate.

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

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

    Designations of certificate stores are platform dependent.

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

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot 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).

    store
    String
    Default Value: "MY"

    The name of the certificate store for the client certificate.

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

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

    Designations of certificate stores are platform dependent.

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

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot 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).

    storePassword
    String
    Default Value: ""

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

    storeType
    CertStoreTypes
    Default Value: 0

    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 ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

    When using a certificate, pass the previously saved security key information as the and set 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.

    subjectAltNames
    String (read-only)
    Default Value: ""

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

    thumbprintMD5
    String (read-only)
    Default Value: ""

    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.

    thumbprintSHA1
    String (read-only)
    Default Value: ""

    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.

    thumbprintSHA256
    String (read-only)
    Default Value: ""

    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.

    usage
    String (read-only)
    Default Value: ""

    The text description of .

    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.

    usageFlags
    Int32 (read-only)
    Default Value: 0

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

    0x80Digital Signature
    0x40Non-Repudiation
    0x20Key Encipherment
    0x10Data Encipherment
    0x08Key Agreement
    0x04Certificate Signing
    0x02CRL Signing
    0x01Encipher Only

    Please see the property for a text representation of .

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

    version
    String (read-only)
    Default Value: ""

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

    subject
    String
    Default Value: ""

    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:

    FieldMeaning
    CNCommon Name. This is commonly a hostname like www.server.com.
    OOrganization
    OUOrganizational Unit
    LLocality
    SState
    CCountry
    EEmail Address

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

    encodedB
    Data
    Default Value: ""

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

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

    encoded
    String
    Default Value: ""

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

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

    Constructors

    public init()

    Creates a instance whose properties can be set. This is useful for use with when generating new certificates. 

    public init(encoded: )

    Parses Encoded as an X.509 public key. 

    public init(storeType: , store: , storePassword: , subject: )

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public init(storeType: , store: , storePassword: , subject: )

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

    Firewall Type

    The firewall the component will connect through.

    Remarks

    When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

    The following fields are available:
  • AutoDetect
  • FirewallType
  • Host
  • Password
  • Port
  • User

    • Fields

    autoDetect
    Bool
    Default Value: False

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

    firewallType
    FirewallTypes
    Default Value: 0

    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. is set to 80.
    fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
    fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
    fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

    host
    String
    Default Value: ""

    The name or IP address of the firewall (optional). If a 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 .

    password
    String
    Default Value: ""

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

    port
    Int32
    Default Value: 0

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

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

    user
    String
    Default Value: ""

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

    Constructors

    public init()

    Config Settings (SSHAuth Module)

    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. SSHChannelData 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 SSHChannelData 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 SSHChannelData fires.

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

    ChannelDataEOLFound[ChannelId]:   Determines if ChannelDataEOL was found.

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

    This configuration setting is valid only when queried inside SSHChannelData, 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 . When set to , 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:

    ValueDescription
    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 SSHHost 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 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. SSHChannelData 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 SSHChannelData 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 SSHChannelData fires.

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

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

    CharacterEscape 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 DataIn 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 DataIn 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 SSHServerAuthentication fires. Valid values are as follows:

    • MD5
    • SHA1
    • SHA256 (default)
    SSHFingerprintMD5:   The server hostkey's MD5 fingerprint.

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

    SSHFingerprintSHA1:   The server hostkey's SHA1 fingerprint.

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

    SSHFingerprintSHA256:   The server hostkey's SHA256 fingerprint.

    This configuration setting may be queried in SSHServerAuthentication 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 SSHCert, 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 . When set to , 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:

    0Disabled. Strict key exchange is not supported in the class.
    1 (default)Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
    2Enabled, but 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.
    3Required. 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 SSHLogoff 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 .

    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:

    0No firewall (default setting).
    1Connect through a tunneling proxy. FirewallPort is set to 80.
    2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
    3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
    10Connect 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 .

    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 LocalHost 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 LocalHost 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 LocalPort after the connection is established.

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

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

    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 to mask sensitive data. The default is .

    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.

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

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

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

    This setting is set to by default on all platforms.

    Trappable Errors (SSHAuth Module)

    TCPClient Errors

    100   You cannot change the RemotePort at this time. A connection is in progress.
    101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
    102   The RemoteHost 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 LocalPort at this time. A connection is in progress.
    107   You cannot change the LocalHost at this time. A connection is in progress.
    112   You cannot change MaxLineLength at this time. A connection is in progress.
    116   RemotePort 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).