Authenticate Method

Authenticates the user.

Syntax

int Authenticate();

Remarks

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

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)