Authenticate Method

Authenticates the user.

Syntax

async sshauth.authenticate(): Promise<void>

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.