(CkPython) 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

Chilkat Python Downloads Python Module for Windows, Linux, Alpine Linux, MAC OS X, Solaris, FreeBSD, OpenBSD, Raspberry Pi and other single board computers

import sys
import chilkat

# 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.
key = chilkat.CkSshKey()
key.put_Password("key_password")

success = key.FromOpenSshPrivateKey(key.loadText("qa_data/my_private_key_file"))
if (success != True):
    print(key.lastErrorText())
    sys.exit()

ssh = chilkat.CkSsh()

success = ssh.Connect("ssh.example.com",22)
if (success != True):
    print(ssh.lastErrorText())
    sys.exit()

# Authenticate using both a password and private key.
success = ssh.AuthenticatePwPk("myLogin","myPassword",key)
if (success == True):
    print("Authentication is successful!")
    sys.exit()

# 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

# json is a CkJsonObject
json = ssh.LastJsonData()
json.put_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:
print("authResult: " + json.stringOf("authResult"))
print("authFailReason: " + json.stringOf("authFailReason"))