SSHAuth Control
Properties Methods Events Config Settings Errors
The SSHAuth control provides a simple way to authenticate a user against an SSH server.
Syntax
SSHAuth
Remarks
The SSHAuth control 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 control 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 control with short descriptions. Click on the links for further details.
| AuthMode | The authentication method to be used with the control when calling Authenticate . |
| FirewallAutoDetect | Whether to automatically detect and use firewall system settings, if available. |
| FirewallType | The type of firewall to connect through. |
| FirewallHost | The name or IP address of the firewall (optional). |
| FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
| FirewallPort | The Transmission Control Protocol (TCP) port for the firewall Host . |
| FirewallUser | A username if authentication is to be used when connecting through a firewall. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the control binds. |
| Password | The password for SSH password-based authentication. |
| SSHAcceptServerHostKeyEffectiveDate | The date on which this certificate becomes valid. |
| SSHAcceptServerHostKeyExpirationDate | The date on which the certificate expires. |
| SSHAcceptServerHostKeyExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSHAcceptServerHostKeyFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSHAcceptServerHostKeyFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSHAcceptServerHostKeyFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSHAcceptServerHostKeyIssuer | The issuer of the certificate. |
| SSHAcceptServerHostKeyPrivateKey | The private key of the certificate (if available). |
| SSHAcceptServerHostKeyPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSHAcceptServerHostKeyPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSHAcceptServerHostKeyPublicKey | The public key of the certificate. |
| SSHAcceptServerHostKeyPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSHAcceptServerHostKeyPublicKeyLength | The length of the certificate's public key (in bits). |
| SSHAcceptServerHostKeySerialNumber | The serial number of the certificate encoded as a string. |
| SSHAcceptServerHostKeySignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSHAcceptServerHostKeyStore | The name of the certificate store for the client certificate. |
| SSHAcceptServerHostKeyStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSHAcceptServerHostKeyStoreType | The type of certificate store for this certificate. |
| SSHAcceptServerHostKeySubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSHAcceptServerHostKeyThumbprintMD5 | The MD5 hash of the certificate. |
| SSHAcceptServerHostKeyThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSHAcceptServerHostKeyThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSHAcceptServerHostKeyUsage | The text description of UsageFlags . |
| SSHAcceptServerHostKeyUsageFlags | The flags that show intended use for the certificate. |
| SSHAcceptServerHostKeyVersion | The certificate's version number. |
| SSHAcceptServerHostKeySubject | The subject of the certificate used for client authentication. |
| SSHAcceptServerHostKeyEncoded | The certificate (PEM/Base64 encoded). |
| SSHCertEffectiveDate | The date on which this certificate becomes valid. |
| SSHCertExpirationDate | The date on which the certificate expires. |
| SSHCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSHCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSHCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSHCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSHCertIssuer | The issuer of the certificate. |
| SSHCertPrivateKey | The private key of the certificate (if available). |
| SSHCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSHCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSHCertPublicKey | The public key of the certificate. |
| SSHCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSHCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SSHCertSerialNumber | The serial number of the certificate encoded as a string. |
| SSHCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSHCertStore | The name of the certificate store for the client certificate. |
| SSHCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSHCertStoreType | The type of certificate store for this certificate. |
| SSHCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSHCertThumbprintMD5 | The MD5 hash of the certificate. |
| SSHCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSHCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSHCertUsage | The text description of UsageFlags . |
| SSHCertUsageFlags | The flags that show intended use for the certificate. |
| SSHCertVersion | The certificate's version number. |
| SSHCertSubject | The subject of the certificate used for client authentication. |
| SSHCertEncoded | The certificate (PEM/Base64 encoded). |
| SSHEncryptionAlgorithms | The comma-separated list containing all allowable encryption algorithms. |
| SSHHost | The address of the Secure Shell (SSH) host. |
| SSHPort | The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22. |
| Timeout | This property includes the timeout for the control. |
| User | The username for SSH authentication. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| Authenticate | Authenticates the user. |
| Config | Sets or retrieves a configuration setting. |
| DoEvents | This method processes events from the internal message queue. |
| Interrupt | This method interrupts the current method. |
| Reset | Resets the control. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in the connection state. |
| Disconnected | Fired when a connection is closed. |
| Error | Fired when information is available about errors during data delivery. |
| Log | Fired once for each log message. |
| SSHCustomAuth | Fired when the control is doing a custom authentication. |
| SSHKeyboardInteractive | Fired when the control receives a request for user input from the server. |
| SSHServerAuthentication | Fired after the server presents its public key to the client. |
| SSHStatus | Fired to track the progress of the secure connection. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| ChannelDataEOL[ChannelId] | Used to break the incoming data stream into chunks. |
| ChannelDataEOLFound[ChannelId] | Determines if ChannelDataEOL was found. |
| ClientSSHVersionString | The SSH version string used by the control. |
| DoNotRepeatAuthMethods | Whether the control will repeat authentication methods during multifactor authentication. |
| EnablePageantAuth | Whether to use a key stored in Pageant to perform client authentication. |
| KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
| KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
| KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| LogLevel | Specifies the level of detail that is logged. |
| MaxChannelDataLength[ChannelId] | The maximum amount of data to accumulate when no ChannelDataEOL is found. |
| MaxPacketSize | The maximum packet size of the channel, in bytes. |
| MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
| NegotiatedStrictKex | Returns whether strict key exchange was negotiated to be used. |
| PasswordPrompt | The text of the password prompt used in keyboard-interactive authentication. |
| PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
| RecordLength | The length of received data records. |
| ServerSSHVersionString | The remote host's SSH version string. |
| SignedSSHCert | The CA signed client public key used when authenticating. |
| SSHAcceptAnyServerHostKey | If set the control will accept any key presented by the server. |
| SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
| SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
| SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
| SSHFingerprintMD5 | The server hostkey's MD5 fingerprint. |
| SSHFingerprintSHA1 | The server hostkey's SHA1 fingerprint. |
| SSHFingerprintSHA256 | The server hostkey's SHA256 fingerprint. |
| SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
| SSHKeepAliveInterval | The interval between keep alive packets. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHKeyRenegotiate | Causes the control to renegotiate the SSH keys. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| SSHPubKeyAuthSigAlgorithms | Specifies the enabled signature algorithms that may be used when attempting public key authentication. |
| SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
| SSHVersionPattern | The pattern used to match the remote host's version string. |
| TryAllAvailableAuthMethods | If set to true, the control will try all available authentication methods. |
| UseStrictKeyExchange | Specifies how strict key exchange is supported. |
| WaitForChannelClose | Whether to wait for channels to be closed before disconnected. |
| WaitForServerDisconnect | Whether to wait for the server to close the connection. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the control binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthMode Property (SSHAuth Control)
The authentication method to be used with the control when calling Authenticate .
Syntax
sshauthcontrol.AuthMode[=integer]
Possible Values
amNone(0), amMultiFactor(1), amPassword(2), amPublicKey(3), amKeyboardInteractive(4), amGSSAPIWithMic(5), amCustom(6)
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 control 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 control 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 control 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 control to attempt a multistep authentication process. The control 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 control will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the control fails with an error. |
| amPassword (2) | The control will use the values of User and Password to authenticate the user. |
| amPublicKey (3) | The control 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 control 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 control 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 control 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 control caller to take over the authentication process completely. When amCustom is set, the control 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)
Data Type
Integer
FirewallAutoDetect Property (SSHAuth Control)
Whether to automatically detect and use firewall system settings, if available.
Syntax
sshauthcontrol.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
Whether to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (SSHAuth Control)
The type of firewall to connect through.
Syntax
sshauthcontrol.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
The type of firewall to connect through. The applicable values are as follows:
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (SSHAuth Control)
The name or IP address of the firewall (optional).
Syntax
sshauthcontrol.FirewallHost[=string]
Default Value
""
Remarks
The name or IP address of the firewall (optional). If a FirewallHost 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 control fails with an error.
Data Type
String
FirewallPassword Property (SSHAuth Control)
A password if authentication is to be used when connecting through the firewall.
Syntax
sshauthcontrol.FirewallPassword[=string]
Default Value
""
Remarks
A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (SSHAuth Control)
The Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
sshauthcontrol.FirewallPort[=integer]
Default Value
0
Remarks
The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (SSHAuth Control)
A username if authentication is to be used when connecting through a firewall.
Syntax
sshauthcontrol.FirewallUser[=string]
Default Value
""
Remarks
A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
LocalHost Property (SSHAuth Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
sshauthcontrol.LocalHost[=string]
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 control initiate connections (or accept in the case of server controls) 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 control 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.
Data Type
String
LocalPort Property (SSHAuth Control)
The TCP port in the local host where the control binds.
Syntax
sshauthcontrol.LocalPort[=integer]
Default Value
0
Remarks
This property must be set before a connection is attempted. It instructs the control 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.
Data Type
Integer
Password Property (SSHAuth Control)
The password for SSH password-based authentication.
Syntax
sshauthcontrol.Password[=string]
Default Value
""
Remarks
Password specifies the password which is used to authenticate the client to the SSH server.
Data Type
String
SSHAcceptServerHostKeyEffectiveDate Property (SSHAuth Control)
The date on which this certificate becomes valid.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyExpirationDate Property (SSHAuth Control)
The date on which the certificate expires.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyExtendedKeyUsage Property (SSHAuth Control)
A comma-delimited list of extended key usage identifiers.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyFingerprint Property (SSHAuth Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyFingerprintSHA1 Property (SSHAuth Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyFingerprintSHA256 Property (SSHAuth Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyIssuer Property (SSHAuth Control)
The issuer of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyPrivateKey Property (SSHAuth Control)
The private key of the certificate (if available).
Syntax
sshauthcontrol.SSHAcceptServerHostKeyPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSHAcceptServerHostKeyPrivateKey may be available but not exportable. In this case, SSHAcceptServerHostKeyPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyPrivateKeyAvailable Property (SSHAuth Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSHAcceptServerHostKeyPrivateKey is available for the selected certificate. If SSHAcceptServerHostKeyPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSHAcceptServerHostKeyPrivateKeyContainer Property (SSHAuth Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
sshauthcontrol.SSHAcceptServerHostKeyPrivateKeyContainer
Default Value
""
Remarks
The name of the SSHAcceptServerHostKeyPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyPublicKey Property (SSHAuth Control)
The public key of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyPublicKeyAlgorithm Property (SSHAuth Control)
The textual description of the certificate's public key algorithm.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyPublicKeyLength Property (SSHAuth Control)
The length of the certificate's public key (in bits).
Syntax
sshauthcontrol.SSHAcceptServerHostKeyPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSHAcceptServerHostKeySerialNumber Property (SSHAuth Control)
The serial number of the certificate encoded as a string.
Syntax
sshauthcontrol.SSHAcceptServerHostKeySerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeySignatureAlgorithm Property (SSHAuth Control)
The text description of the certificate's signature algorithm.
Syntax
sshauthcontrol.SSHAcceptServerHostKeySignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyStore Property (SSHAuth Control)
The name of the certificate store for the client certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSHAcceptServerHostKeyStoreType property denotes the type of the certificate store specified by SSHAcceptServerHostKeyStore. If the store is password-protected, specify the password in SSHAcceptServerHostKeyStorePassword.
SSHAcceptServerHostKeyStore is used in conjunction with the SSHAcceptServerHostKeySubject property to specify client certificates. If SSHAcceptServerHostKeyStore has a value, and SSHAcceptServerHostKeySubject or SSHAcceptServerHostKeyEncoded is set, a search for a certificate is initiated. Please see the SSHAcceptServerHostKeySubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSHAcceptServerHostKeyStoreB.
Data Type
Binary String
SSHAcceptServerHostKeyStorePassword Property (SSHAuth Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSHAcceptServerHostKeyStoreType Property (SSHAuth Control)
The type of certificate store for this certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 control. 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 SSHAcceptServerHostKeyStore and set SSHAcceptServerHostKeyStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
SSHAcceptServerHostKeySubjectAltNames Property (SSHAuth Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeySubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyThumbprintMD5 Property (SSHAuth Control)
The MD5 hash of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyThumbprintSHA1 Property (SSHAuth Control)
The SHA-1 hash of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyThumbprintSHA256 Property (SSHAuth Control)
The SHA-256 hash of the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyUsage Property (SSHAuth Control)
The text description of UsageFlags .
Syntax
sshauthcontrol.SSHAcceptServerHostKeyUsage
Default Value
""
Remarks
The text description of SSHAcceptServerHostKeyUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSHAcceptServerHostKeyUsageFlags Property (SSHAuth Control)
The flags that show intended use for the certificate.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSHAcceptServerHostKeyUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the SSHAcceptServerHostKeyUsage property for a text representation of SSHAcceptServerHostKeyUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSHAcceptServerHostKeyVersion Property (SSHAuth Control)
The certificate's version number.
Syntax
sshauthcontrol.SSHAcceptServerHostKeyVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSHAcceptServerHostKeySubject Property (SSHAuth Control)
The subject of the certificate used for client authentication.
Syntax
sshauthcontrol.SSHAcceptServerHostKeySubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSHAcceptServerHostKeyEncoded Property (SSHAuth Control)
The certificate (PEM/Base64 encoded).
Syntax
sshauthcontrol.SSHAcceptServerHostKeyEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHAcceptServerHostKeyStore and SSHAcceptServerHostKeySubject properties also may be used to specify a certificate.
When SSHAcceptServerHostKeyEncoded is set, a search is initiated in the current SSHAcceptServerHostKeyStore for the private key of the certificate. If the key is found, SSHAcceptServerHostKeySubject is updated to reflect the full subject of the selected certificate; otherwise, SSHAcceptServerHostKeySubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSHAcceptServerHostKeyEncodedB.
This property is not available at design time.
Data Type
Binary String
SSHCertEffectiveDate Property (SSHAuth Control)
The date on which this certificate becomes valid.
Syntax
sshauthcontrol.SSHCertEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSHCertExpirationDate Property (SSHAuth Control)
The date on which the certificate expires.
Syntax
sshauthcontrol.SSHCertExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSHCertExtendedKeyUsage Property (SSHAuth Control)
A comma-delimited list of extended key usage identifiers.
Syntax
sshauthcontrol.SSHCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSHCertFingerprint Property (SSHAuth Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
sshauthcontrol.SSHCertFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSHCertFingerprintSHA1 Property (SSHAuth Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
sshauthcontrol.SSHCertFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSHCertFingerprintSHA256 Property (SSHAuth Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
sshauthcontrol.SSHCertFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSHCertIssuer Property (SSHAuth Control)
The issuer of the certificate.
Syntax
sshauthcontrol.SSHCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSHCertPrivateKey Property (SSHAuth Control)
The private key of the certificate (if available).
Syntax
sshauthcontrol.SSHCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSHCertPrivateKeyAvailable Property (SSHAuth Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
sshauthcontrol.SSHCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSHCertPrivateKeyContainer Property (SSHAuth Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
sshauthcontrol.SSHCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSHCertPublicKey Property (SSHAuth Control)
The public key of the certificate.
Syntax
sshauthcontrol.SSHCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSHCertPublicKeyAlgorithm Property (SSHAuth Control)
The textual description of the certificate's public key algorithm.
Syntax
sshauthcontrol.SSHCertPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSHCertPublicKeyLength Property (SSHAuth Control)
The length of the certificate's public key (in bits).
Syntax
sshauthcontrol.SSHCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSHCertSerialNumber Property (SSHAuth Control)
The serial number of the certificate encoded as a string.
Syntax
sshauthcontrol.SSHCertSerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSHCertSignatureAlgorithm Property (SSHAuth Control)
The text description of the certificate's signature algorithm.
Syntax
sshauthcontrol.SSHCertSignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSHCertStore Property (SSHAuth Control)
The name of the certificate store for the client certificate.
Syntax
sshauthcontrol.SSHCertStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password-protected, specify the password in SSHCertStorePassword.
SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSHCertStoreB.
Data Type
Binary String
SSHCertStorePassword Property (SSHAuth Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
sshauthcontrol.SSHCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSHCertStoreType Property (SSHAuth Control)
The type of certificate store for this certificate.
Syntax
sshauthcontrol.SSHCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 control. 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 SSHCertStore and set SSHCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
SSHCertSubjectAltNames Property (SSHAuth Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
sshauthcontrol.SSHCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSHCertThumbprintMD5 Property (SSHAuth Control)
The MD5 hash of the certificate.
Syntax
sshauthcontrol.SSHCertThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHCertThumbprintSHA1 Property (SSHAuth Control)
The SHA-1 hash of the certificate.
Syntax
sshauthcontrol.SSHCertThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHCertThumbprintSHA256 Property (SSHAuth Control)
The SHA-256 hash of the certificate.
Syntax
sshauthcontrol.SSHCertThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHCertUsage Property (SSHAuth Control)
The text description of UsageFlags .
Syntax
sshauthcontrol.SSHCertUsage
Default Value
""
Remarks
The text description of SSHCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSHCertUsageFlags Property (SSHAuth Control)
The flags that show intended use for the certificate.
Syntax
sshauthcontrol.SSHCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSHCertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the SSHCertUsage property for a text representation of SSHCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSHCertVersion Property (SSHAuth Control)
The certificate's version number.
Syntax
sshauthcontrol.SSHCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSHCertSubject Property (SSHAuth Control)
The subject of the certificate used for client authentication.
Syntax
sshauthcontrol.SSHCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSHCertEncoded Property (SSHAuth Control)
The certificate (PEM/Base64 encoded).
Syntax
sshauthcontrol.SSHCertEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.
When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSHCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSHEncryptionAlgorithms Property (SSHAuth Control)
The comma-separated list containing all allowable encryption algorithms.
Syntax
sshauthcontrol.SSHEncryptionAlgorithms[=string]
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 control 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 control:
| aes256-ctr | 256-bit AES encryption in CTR mode. |
| aes256-cbc | 256-bit AES encryption in CBC mode. |
| aes192-ctr | 192-bit AES encryption in CTR mode. |
| aes192-cbc | 192-bit AES encryption in CBC mode. |
| aes128-ctr | 128-bit AES encryption in CTR mode. |
| aes128-cbc | 128-bit AES encryption in CBC mode. |
| 3des-ctr | 192-bit (3-key) triple DES encryption in CTR mode. |
| 3des-cbc | 192-bit (3-key) triple DES encryption in CBC mode. |
| cast128-cbc | CAST-128 encryption. |
| blowfish-cbc | Blowfish encryption. |
| arcfour | ARC4 encryption. |
| arcfour128 | 128-bit ARC4 encryption. |
| arcfour256 | 256-bit ARC4 encryption. |
| aes256-gcm@openssh.com | 256-bit AES encryption in GCM mode. |
| aes128-gcm@openssh.com | 128-bit AES encryption in GCM mode. |
| chacha20-poly1305@openssh.com | ChaCha20 with Poly1305-AES encryption. |
Data Type
String
SSHHost Property (SSHAuth Control)
The address of the Secure Shell (SSH) host.
Syntax
sshauthcontrol.SSHHost[=string]
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.
Data Type
String
SSHPort Property (SSHAuth Control)
The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.
Syntax
sshauthcontrol.SSHPort[=integer]
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.
Data Type
Integer
Timeout Property (SSHAuth Control)
This property includes the timeout for the control.
Syntax
sshauthcontrol.Timeout[=integer]
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 control will wait for the operation to complete before returning control. The control will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The control 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 control fails with an error.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
User Property (SSHAuth Control)
The username for SSH authentication.
Syntax
sshauthcontrol.User[=string]
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)
Data Type
String
Authenticate Method (SSHAuth Control)
Authenticates the user.
Syntax
sshauthcontrol.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 control fails with an error.
The following common properties are applicable when calling this method:
- User (required)
- Password (required for password authentication)
- SSHCert (required for public key authentication)
- SSHHost (required)
- SSHPort
- AuthMode
- SSHEncryptionAlgorithms
Keyboard interactive authentication is handled through the SSHKeyboardInteractive event.
Config Method (SSHAuth Control)
Sets or retrieves a configuration setting.
Syntax
sshauthcontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)
This method processes events from the internal message queue.
Syntax
sshauthcontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Interrupt Method (SSHAuth Control)
This method interrupts the current method.
Syntax
sshauthcontrol.Interrupt
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (SSHAuth Control)
Resets the control.
Syntax
sshauthcontrol.Reset
Remarks
When called, the control will reset all of its properties to their default values.
Connected Event (SSHAuth Control)
Fired immediately after a connection completes (or fails).
Syntax
Sub sshauthcontrol_Connected(StatusCode As Integer, Description As String)
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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (SSHAuth Control)
Fired to indicate changes in the connection state.
Syntax
Sub sshauthcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)
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. |
Disconnected Event (SSHAuth Control)
Fired when a connection is closed.
Syntax
Sub sshauthcontrol_Disconnected(StatusCode As Integer, Description As String)
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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Please refer to the Error Codes section for more information.
Error Event (SSHAuth Control)
Fired when information is available about errors during data delivery.
Syntax
Sub sshauthcontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (SSHAuth Control)
Fired once for each log message.
Syntax
Sub sshauthcontrol_Log(LogLevel As Integer, Message As String, LogType As String)
Remarks
Fired once for each log message generated by the control. 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 Control)
Fired when the control is doing a custom authentication.
Syntax
Sub sshauthcontrol_SSHCustomAuth(Packet As String)
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 Control)
Fired when the control receives a request for user input from the server.
Syntax
Sub sshauthcontrol_SSHKeyboardInteractive(Name As String, Instructions As String, Prompt As String, Response As String, EchoResponse As Boolean)
Remarks
SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the control will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the control 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 control will fire the SSHKeyboardInteractive event once for each prompt.
SSHServerAuthentication Event (SSHAuth Control)
Fired after the server presents its public key to the client.
Syntax
Sub sshauthcontrol_SSHServerAuthentication(HostKey As String, Fingerprint As String, KeyAlgorithm As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
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
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 Control)
Fired to track the progress of the secure connection.
Syntax
Sub sshauthcontrol_SSHStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Config Settings (SSHAuth Control)
The control 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 control, access to these internal properties is provided through the Config method.SSHAuth Config Settings
At least one supported algorithm must appear in this list. The following compression algorithms are supported by the control:
- zlib
- zlib@openssh.com
- none
SSHClient Config Settings
If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the control 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.
This configuration setting is valid only when queried inside SSHChannelData, MaxChannelDataLength > 0, and ChannelDataEOL is nonempty.
Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.
| Value | Description |
| 0 (Disabled - default) | No communication with Pageant is attempted. |
| 1 (Enabled) | Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key, no error is thrown. |
| 2 (Required) | Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key, an error is thrown. |
Example 1. Enabling Pageant:
component.Config("EnablePageantAuth=1");
component.SSHUser = "sshuser";
component.SSHLogon("localhost", 22);
Note: This functionality is available only on Windows.
Note: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed.
Example. Setting the Threshold to 500 MB:
SSHComponent.Config("KeyRenegotiationThreshold=524288000")
| 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. |
If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the control 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.
Note: This value may be changed during the connection, but the window size can only be increased, not decreased.
component.Config("NegotiatedStrictKex")
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:
| Character | Escape Sequence |
| ? | [?] |
| * | [*] |
| [ | [[] |
| \ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
The default value is 0, meaning this setting is not used.
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...
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");
If the server's fingerprint matches one of the values supplied, the control will accept the host key.
- MD5
- SHA1
- SHA256 (default)
The default value is 0, meaning no keep alives will be sent.
Note: The SSHREVERSETUNNEL control uses a default value of 30.
- 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==
Example 3. Renegotiating SSH Keys:
SSHClient.Config("SSHKeyRenegotiate")
- 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 setting should be a comma-separated list of algorithms. At runtime, the control 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 control 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 control 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.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
Because both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the control provides options to further control the behavior in different scenarios. Possible values for this setting are as follows:
| 0 | Disabled. Strict key exchange is not supported in the control. |
| 1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
| 2 | Enabled, but will reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange, all algorithms may be used. If the remote host does not support strict key exchange, the connection will continue only if the selected encryption and message authentication code (MAC) algorithms are not affected by the Terrapin attack. |
| 3 | Required. If the remote host does not support strict key exchange, the connection will fail. |
When True (default), the control 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 control will still send the channel close messages, but it will not wait for a response and will proceed to close the connection.
When set to True, the control 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
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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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 control 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control 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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control 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
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control 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 Control)
The control may also return one of the following error codes, which are inherited from other controls.
TCPClient Errors
| 20101 | You cannot change the RemotePort at this time. A connection is in progress. |
| 20102 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 20103 | The RemoteHost address is invalid (0.0.0.0). |
| 20105 | Already connected. If you want to reconnect, close the current connection first. |
| 20107 | You cannot change the LocalPort at this time. A connection is in progress. |
| 20108 | You cannot change the LocalHost at this time. A connection is in progress. |
| 20113 | You cannot change MaxLineLength at this time. A connection is in progress. |
| 20117 | RemotePort cannot be zero. Please specify a valid service port number. |
| 20118 | You cannot change the UseConnection option while the control is active. |
| 20136 | Operation would block. |
| 20202 | Timeout. |
| 20212 | Action impossible in control's present state. |
| 20213 | Action impossible while not connected. |
| 20214 | Action impossible while listening. |
| 20302 | Timeout. |
| 20303 | Could not open file. |
| 20435 | Unable to convert string to selected CodePage. |
| 21106 | Already connecting. If you want to reconnect, close the current connection first. |
| 21118 | You need to connect first. |
| 21120 | You cannot change the LocalHost at this time. A connection is in progress. |
| 21121 | Connection dropped by remote host. |
TCP/IP Errors
| 25005 | [10004] Interrupted system call. |
| 25010 | [10009] Bad file number. |
| 25014 | [10013] Access denied. |
| 25015 | [10014] Bad address. |
| 25023 | [10022] Invalid argument. |
| 25025 | [10024] Too many open files. |
| 25036 | [10035] Operation would block. |
| 25037 | [10036] Operation now in progress. |
| 25038 | [10037] Operation already in progress. |
| 25039 | [10038] Socket operation on nonsocket. |
| 25040 | [10039] Destination address required. |
| 25041 | [10040] Message is too long. |
| 25042 | [10041] Protocol wrong type for socket. |
| 25043 | [10042] Bad protocol option. |
| 25044 | [10043] Protocol is not supported. |
| 25045 | [10044] Socket type is not supported. |
| 25046 | [10045] Operation is not supported on socket. |
| 25047 | [10046] Protocol family is not supported. |
| 25048 | [10047] Address family is not supported by protocol family. |
| 25049 | [10048] Address already in use. |
| 25050 | [10049] Cannot assign requested address. |
| 25051 | [10050] Network is down. |
| 25052 | [10051] Network is unreachable. |
| 25053 | [10052] Net dropped connection or reset. |
| 25054 | [10053] Software caused connection abort. |
| 25055 | [10054] Connection reset by peer. |
| 25056 | [10055] No buffer space available. |
| 25057 | [10056] Socket is already connected. |
| 25058 | [10057] Socket is not connected. |
| 25059 | [10058] Cannot send after socket shutdown. |
| 25060 | [10059] Too many references, cannot splice. |
| 25061 | [10060] Connection timed out. |
| 25062 | [10061] Connection refused. |
| 25063 | [10062] Too many levels of symbolic links. |
| 25064 | [10063] File name is too long. |
| 25065 | [10064] Host is down. |
| 25066 | [10065] No route to host. |
| 25067 | [10066] Directory is not empty |
| 25068 | [10067] Too many processes. |
| 25069 | [10068] Too many users. |
| 25070 | [10069] Disc Quota Exceeded. |
| 25071 | [10070] Stale NFS file handle. |
| 25072 | [10071] Too many levels of remote in path. |
| 25092 | [10091] Network subsystem is unavailable. |
| 25093 | [10092] WINSOCK DLL Version out of range. |
| 25094 | [10093] Winsock is not loaded yet. |
| 26002 | [11001] Host not found. |
| 26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 26005 | [11004] Valid name, no data record (check DNS setup). |