SSHAuth Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipaSSHAuth

Remarks

The SSHAuth component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AuthMode Property (SSHAuth Component)

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

Syntax

__property TipaSSHAuthAuthModes AuthMode = { read=FAuthMode, write=FSetAuthMode };

enum TipaSSHAuthAuthModes {
  amNone=0,
  amMultiFactor=1,
  amPassword=2,
  amPublicKey=3,
  amKeyboardInteractive=4,
  amGSSAPIWithMic=5,
  amCustom=6
};

Default Value

amPassword

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 component 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 component 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 component supports the following authentication methods:

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

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (SSHAuth Component)

The type of firewall to connect through.

Syntax

__property TipaSSHAuthFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TipaSSHAuthFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (SSHAuth Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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 component raises an exception.

Data Type

String

FirewallPassword Property (SSHAuth Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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 component raises an exception.

Data Type

String

FirewallPort Property (SSHAuth Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

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

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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 component raises an exception.

Data Type

String

LocalHost Property (SSHAuth Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

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 component initiate connections (or accept in the case of server components) 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 component 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 Component)

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

Syntax

__property int LocalPort = { read=FLocalPort, write=FSetLocalPort };

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the component 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 Component)

The password for SSH password-based authentication.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

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

Data Type

String

SSHAcceptServerHostKeyEffectiveDate Property (SSHAuth Component)

The date on which this certificate becomes valid.

Syntax

__property String SSHAcceptServerHostKeyEffectiveDate = { read=FSSHAcceptServerHostKeyEffectiveDate };

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

The date on which the certificate expires.

Syntax

__property String SSHAcceptServerHostKeyExpirationDate = { read=FSSHAcceptServerHostKeyExpirationDate };

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

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSHAcceptServerHostKeyExtendedKeyUsage = { read=FSSHAcceptServerHostKeyExtendedKeyUsage };

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

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

Syntax

__property String SSHAcceptServerHostKeyFingerprint = { read=FSSHAcceptServerHostKeyFingerprint };

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

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

Syntax

__property String SSHAcceptServerHostKeyFingerprintSHA1 = { read=FSSHAcceptServerHostKeyFingerprintSHA1 };

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

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

Syntax

__property String SSHAcceptServerHostKeyFingerprintSHA256 = { read=FSSHAcceptServerHostKeyFingerprintSHA256 };

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

The issuer of the certificate.

Syntax

__property String SSHAcceptServerHostKeyIssuer = { read=FSSHAcceptServerHostKeyIssuer };

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

The private key of the certificate (if available).

Syntax

__property String SSHAcceptServerHostKeyPrivateKey = { read=FSSHAcceptServerHostKeyPrivateKey };

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

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSHAcceptServerHostKeyPrivateKeyAvailable = { read=FSSHAcceptServerHostKeyPrivateKeyAvailable };

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

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

Syntax

__property String SSHAcceptServerHostKeyPrivateKeyContainer = { read=FSSHAcceptServerHostKeyPrivateKeyContainer };

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

The public key of the certificate.

Syntax

__property String SSHAcceptServerHostKeyPublicKey = { read=FSSHAcceptServerHostKeyPublicKey };

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

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

Syntax

__property String SSHAcceptServerHostKeyPublicKeyAlgorithm = { read=FSSHAcceptServerHostKeyPublicKeyAlgorithm };

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

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

Syntax

__property int SSHAcceptServerHostKeyPublicKeyLength = { read=FSSHAcceptServerHostKeyPublicKeyLength };

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

The serial number of the certificate encoded as a string.

Syntax

__property String SSHAcceptServerHostKeySerialNumber = { read=FSSHAcceptServerHostKeySerialNumber };

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

The text description of the certificate's signature algorithm.

Syntax

__property String SSHAcceptServerHostKeySignatureAlgorithm = { read=FSSHAcceptServerHostKeySignatureAlgorithm };

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

The name of the certificate store for the client certificate.

Syntax

__property String SSHAcceptServerHostKeyStore = { read=FSSHAcceptServerHostKeyStore, write=FSetSSHAcceptServerHostKeyStore };
__property DynamicArray<Byte> SSHAcceptServerHostKeyStoreB = { read=FSSHAcceptServerHostKeyStoreB, write=FSetSSHAcceptServerHostKeyStoreB };

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:

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

Data Type

Byte Array

SSHAcceptServerHostKeyStorePassword Property (SSHAuth Component)

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

Syntax

__property String SSHAcceptServerHostKeyStorePassword = { read=FSSHAcceptServerHostKeyStorePassword, write=FSetSSHAcceptServerHostKeyStorePassword };

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

The type of certificate store for this certificate.

Syntax

__property TipaSSHAuthSSHAcceptServerHostKeyStoreTypes SSHAcceptServerHostKeyStoreType = { read=FSSHAcceptServerHostKeyStoreType, write=FSetSSHAcceptServerHostKeyStoreType };

enum TipaSSHAuthSSHAcceptServerHostKeyStoreTypes {
  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

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSHAcceptServerHostKeySubjectAltNames Property (SSHAuth Component)

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

Syntax

__property String SSHAcceptServerHostKeySubjectAltNames = { read=FSSHAcceptServerHostKeySubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintMD5 Property (SSHAuth Component)

The MD5 hash of the certificate.

Syntax

__property String SSHAcceptServerHostKeyThumbprintMD5 = { read=FSSHAcceptServerHostKeyThumbprintMD5 };

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

The SHA-1 hash of the certificate.

Syntax

__property String SSHAcceptServerHostKeyThumbprintSHA1 = { read=FSSHAcceptServerHostKeyThumbprintSHA1 };

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

The SHA-256 hash of the certificate.

Syntax

__property String SSHAcceptServerHostKeyThumbprintSHA256 = { read=FSSHAcceptServerHostKeyThumbprintSHA256 };

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

The text description of UsageFlags .

Syntax

__property String SSHAcceptServerHostKeyUsage = { read=FSSHAcceptServerHostKeyUsage };

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

The flags that show intended use for the certificate.

Syntax

__property int SSHAcceptServerHostKeyUsageFlags = { read=FSSHAcceptServerHostKeyUsageFlags };

Default Value

0

Remarks

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

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

The certificate's version number.

Syntax

__property String SSHAcceptServerHostKeyVersion = { read=FSSHAcceptServerHostKeyVersion };

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

The subject of the certificate used for client authentication.

Syntax

__property String SSHAcceptServerHostKeySubject = { read=FSSHAcceptServerHostKeySubject, write=FSetSSHAcceptServerHostKeySubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSHAcceptServerHostKeyEncoded Property (SSHAuth Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSHAcceptServerHostKeyEncoded = { read=FSSHAcceptServerHostKeyEncoded, write=FSetSSHAcceptServerHostKeyEncoded };
__property DynamicArray<Byte> SSHAcceptServerHostKeyEncodedB = { read=FSSHAcceptServerHostKeyEncodedB, write=FSetSSHAcceptServerHostKeyEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

SSHCertEffectiveDate Property (SSHAuth Component)

The date on which this certificate becomes valid.

Syntax

__property String SSHCertEffectiveDate = { read=FSSHCertEffectiveDate };

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

The date on which the certificate expires.

Syntax

__property String SSHCertExpirationDate = { read=FSSHCertExpirationDate };

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

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSHCertExtendedKeyUsage = { read=FSSHCertExtendedKeyUsage };

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

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

Syntax

__property String SSHCertFingerprint = { read=FSSHCertFingerprint };

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

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

Syntax

__property String SSHCertFingerprintSHA1 = { read=FSSHCertFingerprintSHA1 };

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

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

Syntax

__property String SSHCertFingerprintSHA256 = { read=FSSHCertFingerprintSHA256 };

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

The issuer of the certificate.

Syntax

__property String SSHCertIssuer = { read=FSSHCertIssuer };

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

The private key of the certificate (if available).

Syntax

__property String SSHCertPrivateKey = { read=FSSHCertPrivateKey };

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

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSHCertPrivateKeyAvailable = { read=FSSHCertPrivateKeyAvailable };

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

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

Syntax

__property String SSHCertPrivateKeyContainer = { read=FSSHCertPrivateKeyContainer };

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

The public key of the certificate.

Syntax

__property String SSHCertPublicKey = { read=FSSHCertPublicKey };

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

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

Syntax

__property String SSHCertPublicKeyAlgorithm = { read=FSSHCertPublicKeyAlgorithm };

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

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

Syntax

__property int SSHCertPublicKeyLength = { read=FSSHCertPublicKeyLength };

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

The serial number of the certificate encoded as a string.

Syntax

__property String SSHCertSerialNumber = { read=FSSHCertSerialNumber };

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

The text description of the certificate's signature algorithm.

Syntax

__property String SSHCertSignatureAlgorithm = { read=FSSHCertSignatureAlgorithm };

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

The name of the certificate store for the client certificate.

Syntax

__property String SSHCertStore = { read=FSSHCertStore, write=FSetSSHCertStore };
__property DynamicArray<Byte> SSHCertStoreB = { read=FSSHCertStoreB, write=FSetSSHCertStoreB };

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:

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

Data Type

Byte Array

SSHCertStorePassword Property (SSHAuth Component)

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

Syntax

__property String SSHCertStorePassword = { read=FSSHCertStorePassword, write=FSetSSHCertStorePassword };

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

The type of certificate store for this certificate.

Syntax

__property TipaSSHAuthSSHCertStoreTypes SSHCertStoreType = { read=FSSHCertStoreType, write=FSetSSHCertStoreType };

enum TipaSSHAuthSSHCertStoreTypes {
  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

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSHCertSubjectAltNames Property (SSHAuth Component)

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

Syntax

__property String SSHCertSubjectAltNames = { read=FSSHCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (SSHAuth Component)

The MD5 hash of the certificate.

Syntax

__property String SSHCertThumbprintMD5 = { read=FSSHCertThumbprintMD5 };

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

The SHA-1 hash of the certificate.

Syntax

__property String SSHCertThumbprintSHA1 = { read=FSSHCertThumbprintSHA1 };

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

The SHA-256 hash of the certificate.

Syntax

__property String SSHCertThumbprintSHA256 = { read=FSSHCertThumbprintSHA256 };

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

The text description of UsageFlags .

Syntax

__property String SSHCertUsage = { read=FSSHCertUsage };

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

The flags that show intended use for the certificate.

Syntax

__property int SSHCertUsageFlags = { read=FSSHCertUsageFlags };

Default Value

0

Remarks

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

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

The certificate's version number.

Syntax

__property String SSHCertVersion = { read=FSSHCertVersion };

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

The subject of the certificate used for client authentication.

Syntax

__property String SSHCertSubject = { read=FSSHCertSubject, write=FSetSSHCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSHCertEncoded Property (SSHAuth Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSHCertEncoded = { read=FSSHCertEncoded, write=FSetSSHCertEncoded };
__property DynamicArray<Byte> SSHCertEncodedB = { read=FSSHCertEncodedB, write=FSetSSHCertEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

SSHEncryptionAlgorithms Property (SSHAuth Component)

The comma-separated list containing all allowable encryption algorithms.

Syntax

__property String SSHEncryptionAlgorithms = { read=FSSHEncryptionAlgorithms, write=FSetSSHEncryptionAlgorithms };

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

Data Type

String

SSHHost Property (SSHAuth Component)

The address of the Secure Shell (SSH) host.

Syntax

__property String SSHHost = { read=FSSHHost, write=FSetSSHHost };

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

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

Syntax

__property int SSHPort = { read=FSSHPort, write=FSetSSHPort };

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

This property includes the timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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 component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The component 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 component raises an exception.

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

The username for SSH authentication.

Syntax

__property String User = { read=FUser, write=FSetUser };

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

Authenticates the user.

Syntax

void __fastcall 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 component raises an exception.

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

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

This method processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

Interrupt Method (SSHAuth Component)

This method interrupts the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

Reset Method (SSHAuth Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

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

Connected Event (SSHAuth Component)

Fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TipaSSHAuthConnectedEventParams;
typedef void __fastcall (__closure *TipaSSHAuthConnectedEvent)(System::TObject* Sender, TipaSSHAuthConnectedEventParams *e);
__property TipaSSHAuthConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SSHAuth Component)

Fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TipaSSHAuthConnectionStatusEventParams;
typedef void __fastcall (__closure *TipaSSHAuthConnectionStatusEvent)(System::TObject* Sender, TipaSSHAuthConnectionStatusEventParams *e);
__property TipaSSHAuthConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

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:

Disconnected Event (SSHAuth Component)

Fired when a connection is closed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TipaSSHAuthDisconnectedEventParams;
typedef void __fastcall (__closure *TipaSSHAuthDisconnectedEvent)(System::TObject* Sender, TipaSSHAuthDisconnectedEventParams *e);
__property TipaSSHAuthDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

Remarks

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

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

Please refer to the Error Codes section for more information.

Error Event (SSHAuth Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipaSSHAuthErrorEventParams;
typedef void __fastcall (__closure *TipaSSHAuthErrorEvent)(System::TObject* Sender, TipaSSHAuthErrorEventParams *e);
__property TipaSSHAuthErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

Fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TipaSSHAuthLogEventParams;
typedef void __fastcall (__closure *TipaSSHAuthLogEvent)(System::TObject* Sender, TipaSSHAuthLogEventParams *e);
__property TipaSSHAuthLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

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

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

Message is the log message.

LogType is reserved for future use.

SSHCustomAuth Event (SSHAuth Component)

Fired when the component is doing a custom authentication.

Syntax

typedef struct {
  String Packet;
} TipaSSHAuthSSHCustomAuthEventParams;
typedef void __fastcall (__closure *TipaSSHAuthSSHCustomAuthEvent)(System::TObject* Sender, TipaSSHAuthSSHCustomAuthEventParams *e);
__property TipaSSHAuthSSHCustomAuthEvent OnSSHCustomAuth = { read=FOnSSHCustomAuth, write=FOnSSHCustomAuth };

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

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

Syntax

typedef struct {
  String Name;
  String Instructions;
  String Prompt;
  String Response;
  bool EchoResponse;
} TipaSSHAuthSSHKeyboardInteractiveEventParams;
typedef void __fastcall (__closure *TipaSSHAuthSSHKeyboardInteractiveEvent)(System::TObject* Sender, TipaSSHAuthSSHKeyboardInteractiveEventParams *e);
__property TipaSSHAuthSSHKeyboardInteractiveEvent OnSSHKeyboardInteractive = { read=FOnSSHKeyboardInteractive, write=FOnSSHKeyboardInteractive };

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the component will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the component 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 component will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SSHAuth Component)

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

Syntax

typedef struct {
  String HostKey;
  DynamicArray<Byte> HostKeyB;
  String Fingerprint;
  String KeyAlgorithm;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TipaSSHAuthSSHServerAuthenticationEventParams;
typedef void __fastcall (__closure *TipaSSHAuthSSHServerAuthenticationEvent)(System::TObject* Sender, TipaSSHAuthSSHServerAuthenticationEventParams *e);
__property TipaSSHAuthSSHServerAuthenticationEvent OnSSHServerAuthentication = { read=FOnSSHServerAuthentication, write=FOnSSHServerAuthentication };

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

Fired to track the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TipaSSHAuthSSHStatusEventParams;
typedef void __fastcall (__closure *TipaSSHAuthSSHStatusEvent)(System::TObject* Sender, TipaSSHAuthSSHStatusEventParams *e);
__property TipaSSHAuthSSHStatusEvent OnSSHStatus = { read=FOnSSHStatus, write=FOnSSHStatus };

Remarks

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

Config Settings (SSHAuth Component)

SSHAuth Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SSHAuth Component)

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

TCPClient Errors

TCP/IP Errors