(Excel) SSH Auth Failure Reason (AuthenticatePwPk)

This example demonstrates how to determine the failure reason for the case where both a password and private key are required for authentication. If authentication fails, was it because of an invalid private key, or an invalid password?

Note: This example requires a feature introduced in Chilkat v9.5.0.79

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' Load a private key to be used for SSH authentication.
Dim key As Chilkat.SshKey
Set key = Chilkat.NewSshKey
key.Password = "key_password"


success = key.FromOpenSshPrivateKey(key.LoadText("qa_data/my_private_key_file"))
If (success <> True) Then
    Debug.Print key.LastErrorText
    Exit Sub
End If

Dim ssh As Chilkat.Ssh
Set ssh = Chilkat.NewSsh

success = ssh.Connect("ssh.example.com",22)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Authenticate using both a password and private key.
success = ssh.AuthenticatePwPk("myLogin","myPassword",key)
If (success = True) Then
    Debug.Print "Authentication is successful!"
    Exit Sub
End If

' If we get here, it means the authentication failed.
' To find out why, get the LastJsonData
' This is a feature added in Chilkat v9.5.0.79


Set json = ssh.LastJsonData()
json.EmitCompact = False

' This is the JSON if the key is correct, but the password is incorrect:

' {
'   "public_key_type": "rsa",
'   "partialAuthResult": "publickey success. continue to authenticate with password...",
'   "authResult": "failed",
'   "authFailReason": "Password is incorrect"
' }

' This is the JSON if the key is incorrect.  We won't know if the password is also incorrect until
' the key is made correct so that authentication proceeds to check the password.

' {
'   "public_key_type": "rsa",
'   "authResult": "failed",
'   "authFailReason": "Key is incorrect"
' }

' To get the authResult anbd authFailReason:
Debug.Print "authResult: "; json.StringOf("authResult")
Debug.Print "authFailReason: "; json.StringOf("authFailReason")