SSHAuth Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksAuth_SSHAuth

Procedural Interface

 ipworksauth_sshauth_open();
 ipworksauth_sshauth_close($res);
 ipworksauth_sshauth_register_callback($res, $id, $function);
 ipworksauth_sshauth_get_last_error($res);
 ipworksauth_sshauth_get_last_error_code($res);
 ipworksauth_sshauth_set($res, $id, $index, $value);
 ipworksauth_sshauth_get($res, $id, $index);
 ipworksauth_sshauth_do_authenticate($res);
 ipworksauth_sshauth_do_config($res, $configurationstring);
 ipworksauth_sshauth_do_doevents($res);
 ipworksauth_sshauth_do_interrupt($res);
 ipworksauth_sshauth_do_reset($res);

Remarks

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

To begin specify the SSHHost, User, and Password. Next call Authenticate to authenticate the user.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AuthMode Property (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getAuthMode();


public function setAuthMode($value);

Procedural Interface

ipworksauth_sshauth_get($res, 1 );


ipworksauth_sshauth_set($res, 1, $value );

Default Value

2

Remarks

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

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

Example (User/Password Auth): Control.SSHAuthMode = SshauthSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): 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 (IPWorksAuth_SSHAuth Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

ipworksauth_sshauth_get($res, 2 );


ipworksauth_sshauth_set($res, 2, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksAuth_SSHAuth Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

ipworksauth_sshauth_get($res, 3 );


ipworksauth_sshauth_set($res, 3, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksAuth_SSHAuth Class)

This property contains the name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

ipworksauth_sshauth_get($res, 4 );


ipworksauth_sshauth_set($res, 4, $value );

Default Value

''

Remarks

This property contains 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 class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksAuth_SSHAuth Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

ipworksauth_sshauth_get($res, 5 );


ipworksauth_sshauth_set($res, 5, $value );

Default Value

''

Remarks

This property contains 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 class fails with an error.

Data Type

String

FirewallPort Property (IPWorksAuth_SSHAuth Class)

This property contains the Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

ipworksauth_sshauth_get($res, 6 );


ipworksauth_sshauth_set($res, 6, $value );

Default Value

0

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains a username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

ipworksauth_sshauth_get($res, 7 );


ipworksauth_sshauth_set($res, 7, $value );

Default Value

''

Remarks

This property contains 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 class fails with an error.

Data Type

String

LocalHost Property (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

ipworksauth_sshauth_get($res, 8 );


ipworksauth_sshauth_set($res, 8, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

LocalPort Property (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworksauth_sshauth_get($res, 9 );


ipworksauth_sshauth_set($res, 9, $value );

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

Password Property (IPWorksAuth_SSHAuth Class)

The password for SSH password-based authentication.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

ipworksauth_sshauth_get($res, 10 );


ipworksauth_sshauth_set($res, 10, $value );

Default Value

''

Remarks

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

Data Type

String

SSHAcceptServerHostKeyEffectiveDate Property (IPWorksAuth_SSHAuth Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHAcceptServerHostKeyEffectiveDate();

Procedural Interface

ipworksauth_sshauth_get($res, 11 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExpirationDate();

Procedural Interface

ipworksauth_sshauth_get($res, 12 );

Default Value

''

Remarks

This is the date 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 (IPWorksAuth_SSHAuth Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExtendedKeyUsage();

Procedural Interface

ipworksauth_sshauth_get($res, 13 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprint();

Procedural Interface

ipworksauth_sshauth_get($res, 14 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA1();

Procedural Interface

ipworksauth_sshauth_get($res, 15 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA256();

Procedural Interface

ipworksauth_sshauth_get($res, 16 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyIssuer();

Procedural Interface

ipworksauth_sshauth_get($res, 17 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKey();

Procedural Interface

ipworksauth_sshauth_get($res, 18 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyAvailable();

Procedural Interface

ipworksauth_sshauth_get($res, 19 );

Default Value

false

Remarks

This property shows 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyContainer();

Procedural Interface

ipworksauth_sshauth_get($res, 20 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKey();

Procedural Interface

ipworksauth_sshauth_get($res, 21 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyAlgorithm();

Procedural Interface

ipworksauth_sshauth_get($res, 22 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyLength();

Procedural Interface

ipworksauth_sshauth_get($res, 23 );

Default Value

0

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHAcceptServerHostKeySerialNumber();

Procedural Interface

ipworksauth_sshauth_get($res, 24 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeySignatureAlgorithm();

Procedural Interface

ipworksauth_sshauth_get($res, 25 );

Default Value

''

Remarks

The property contains 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 (IPWorksAuth_SSHAuth Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStore();


public function setSSHAcceptServerHostKeyStore($value);

Procedural Interface

ipworksauth_sshauth_get($res, 26 );


ipworksauth_sshauth_set($res, 26, $value );

Default Value

'MY'

Remarks

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

Binary String

SSHAcceptServerHostKeyStorePassword Property (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHAcceptServerHostKeyStorePassword();


public function setSSHAcceptServerHostKeyStorePassword($value);

Procedural Interface

ipworksauth_sshauth_get($res, 27 );


ipworksauth_sshauth_set($res, 27, $value );

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 (IPWorksAuth_SSHAuth Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStoreType();


public function setSSHAcceptServerHostKeyStoreType($value);

Procedural Interface

ipworksauth_sshauth_get($res, 28 );


ipworksauth_sshauth_set($res, 28, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSHAcceptServerHostKeySubjectAltNames Property (IPWorksAuth_SSHAuth Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeySubjectAltNames();

Procedural Interface

ipworksauth_sshauth_get($res, 29 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintMD5 Property (IPWorksAuth_SSHAuth Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintMD5();

Procedural Interface

ipworksauth_sshauth_get($res, 30 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA1();

Procedural Interface

ipworksauth_sshauth_get($res, 31 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA256();

Procedural Interface

ipworksauth_sshauth_get($res, 32 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsage();

Procedural Interface

ipworksauth_sshauth_get($res, 33 );

Default Value

''

Remarks

This property contains the text description of SSHAcceptServerHostKeyUsageFlags.

This value will be of 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 (IPWorksAuth_SSHAuth Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsageFlags();

Procedural Interface

ipworksauth_sshauth_get($res, 34 );

Default Value

0

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSSHAcceptServerHostKeyVersion();

Procedural Interface

ipworksauth_sshauth_get($res, 35 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHAcceptServerHostKeySubject();


public function setSSHAcceptServerHostKeySubject($value);

Procedural Interface

ipworksauth_sshauth_get($res, 36 );


ipworksauth_sshauth_set($res, 36, $value );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHAcceptServerHostKeyEncoded();


public function setSSHAcceptServerHostKeyEncoded($value);

Procedural Interface

ipworksauth_sshauth_get($res, 37 );


ipworksauth_sshauth_set($res, 37, $value );

Default Value

''

Remarks

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

Binary String

SSHCertEffectiveDate Property (IPWorksAuth_SSHAuth Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHCertEffectiveDate();

Procedural Interface

ipworksauth_sshauth_get($res, 38 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSSHCertExpirationDate();

Procedural Interface

ipworksauth_sshauth_get($res, 39 );

Default Value

''

Remarks

This is the date 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 (IPWorksAuth_SSHAuth Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHCertExtendedKeyUsage();

Procedural Interface

ipworksauth_sshauth_get($res, 40 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHCertFingerprint();

Procedural Interface

ipworksauth_sshauth_get($res, 41 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHCertFingerprintSHA1();

Procedural Interface

ipworksauth_sshauth_get($res, 42 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHCertFingerprintSHA256();

Procedural Interface

ipworksauth_sshauth_get($res, 43 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSSHCertIssuer();

Procedural Interface

ipworksauth_sshauth_get($res, 44 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKey();

Procedural Interface

ipworksauth_sshauth_get($res, 45 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_sshauth_get($res, 46 );

Default Value

false

Remarks

This property shows 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHCertPrivateKeyContainer();

Procedural Interface

ipworksauth_sshauth_get($res, 47 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSSHCertPublicKey();

Procedural Interface

ipworksauth_sshauth_get($res, 48 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_sshauth_get($res, 49 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHCertPublicKeyLength();

Procedural Interface

ipworksauth_sshauth_get($res, 50 );

Default Value

0

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHCertSerialNumber();

Procedural Interface

ipworksauth_sshauth_get($res, 51 );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHCertSignatureAlgorithm();

Procedural Interface

ipworksauth_sshauth_get($res, 52 );

Default Value

''

Remarks

The property contains 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 (IPWorksAuth_SSHAuth Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHCertStore();


public function setSSHCertStore($value);

Procedural Interface

ipworksauth_sshauth_get($res, 53 );


ipworksauth_sshauth_set($res, 53, $value );

Default Value

'MY'

Remarks

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

Binary String

SSHCertStorePassword Property (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHCertStorePassword();


public function setSSHCertStorePassword($value);

Procedural Interface

ipworksauth_sshauth_get($res, 54 );


ipworksauth_sshauth_set($res, 54, $value );

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 (IPWorksAuth_SSHAuth Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSHCertStoreType();


public function setSSHCertStoreType($value);

Procedural Interface

ipworksauth_sshauth_get($res, 55 );


ipworksauth_sshauth_set($res, 55, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSHCertSubjectAltNames Property (IPWorksAuth_SSHAuth Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHCertSubjectAltNames();

Procedural Interface

ipworksauth_sshauth_get($res, 56 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (IPWorksAuth_SSHAuth Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintMD5();

Procedural Interface

ipworksauth_sshauth_get($res, 57 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA1();

Procedural Interface

ipworksauth_sshauth_get($res, 58 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA256();

Procedural Interface

ipworksauth_sshauth_get($res, 59 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSSHCertUsage();

Procedural Interface

ipworksauth_sshauth_get($res, 60 );

Default Value

''

Remarks

This property contains the text description of SSHCertUsageFlags.

This value will be of 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 (IPWorksAuth_SSHAuth Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHCertUsageFlags();

Procedural Interface

ipworksauth_sshauth_get($res, 61 );

Default Value

0

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSSHCertVersion();

Procedural Interface

ipworksauth_sshauth_get($res, 62 );

Default Value

''

Remarks

This property contains 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 (IPWorksAuth_SSHAuth Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHCertSubject();


public function setSSHCertSubject($value);

Procedural Interface

ipworksauth_sshauth_get($res, 63 );


ipworksauth_sshauth_set($res, 63, $value );

Default Value

''

Remarks

This is 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 (IPWorksAuth_SSHAuth Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHCertEncoded();


public function setSSHCertEncoded($value);

Procedural Interface

ipworksauth_sshauth_get($res, 64 );


ipworksauth_sshauth_set($res, 64, $value );

Default Value

''

Remarks

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

Binary String

SSHEncryptionAlgorithms Property (IPWorksAuth_SSHAuth Class)

A comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface

public function getSSHEncryptionAlgorithms();


public function setSSHEncryptionAlgorithms($value);

Procedural Interface

ipworksauth_sshauth_get($res, 65 );


ipworksauth_sshauth_set($res, 65, $value );

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 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, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.

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

Data Type

String

SSHHost Property (IPWorksAuth_SSHAuth Class)

The address of the SSH host.

Object Oriented Interface

public function getSSHHost();


public function setSSHHost($value);

Procedural Interface

ipworksauth_sshauth_get($res, 66 );


ipworksauth_sshauth_set($res, 66, $value );

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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function getSSHPort();


public function setSSHPort($value);

Procedural Interface

ipworksauth_sshauth_get($res, 67 );


ipworksauth_sshauth_set($res, 67, $value );

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 (IPWorksAuth_SSHAuth Class)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworksauth_sshauth_get($res, 68 );


ipworksauth_sshauth_set($res, 68, $value );

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class 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 (IPWorksAuth_SSHAuth Class)

The username for SSH authentication.

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

ipworksauth_sshauth_get($res, 69 );


ipworksauth_sshauth_set($res, 69, $value );

Default Value

''

Remarks

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

Example (User/Password Auth): Control.SSHAuthMode = SshauthSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): 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 (IPWorksAuth_SSHAuth Class)

Authenticates the user.

Object Oriented Interface

public function doAuthenticate();

Procedural Interface

ipworksauth_sshauth_do_authenticate($res);

Remarks

This method authenticates the user against the SSHHost. If authentication succeeds this method returns without error. If authentication fails, or an error is encountered, the class 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 (IPWorksAuth_SSHAuth Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksauth_sshauth_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoEvents Method (IPWorksAuth_SSHAuth Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksauth_sshauth_do_doevents($res);

Remarks

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

Interrupt Method (IPWorksAuth_SSHAuth Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksauth_sshauth_do_interrupt($res);

Remarks

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

Reset Method (IPWorksAuth_SSHAuth Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksauth_sshauth_do_reset($res);

Remarks

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

Connected Event (IPWorksAuth_SSHAuth Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorksAuth_SSHAuth Class)

This event is fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

The ConnectionStatus 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 (IPWorksAuth_SSHAuth Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

Error Event (IPWorksAuth_SSHAuth Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 4, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Log Event (IPWorksAuth_SSHAuth Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.

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

Message is the log message.

LogType is reserved for future use.

SSHCustomAuth Event (IPWorksAuth_SSHAuth Class)

Fired when the class is doing custom authentication.

Object Oriented Interface

public function fireSSHCustomAuth($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 6, array($this, 'fireSSHCustomAuth'));

Parameter List

 'packet'

Remarks

SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last 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 (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function fireSSHKeyboardInteractive($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 7, array($this, 'fireSSHKeyboardInteractive'));

Parameter List

 'name'
 'instructions'
 'prompt'
 'response'
 'echoresponse'

Remarks

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

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

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

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

SSHServerAuthentication Event (IPWorksAuth_SSHAuth Class)

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

Object Oriented Interface

public function fireSSHServerAuthentication($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 8, array($this, 'fireSSHServerAuthentication'));

Parameter List

 'hostkey'
 'fingerprint'
 'keyalgorithm'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the 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 that 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. Supported values are:

• 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 only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

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

Status is reserved for future use.

SSHStatus Event (IPWorksAuth_SSHAuth Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSHStatus($param);

Procedural Interface

ipworksauth_sshauth_register_callback($res, 9, array($this, 'fireSSHStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (SSHAuth Class)

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

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

TCPClient Errors

TCP/IP Errors