(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require '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.new()
key.put_Password("key_password")

success = key.FromOpenSshPrivateKey(key.loadText("qa_data/my_private_key_file"))
if (success != true)
    print key.lastErrorText() + "\n";
    exit
end

ssh = Chilkat::CkSsh.new()

success = ssh.Connect("ssh.example.com",22)
if (success != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# Authenticate using both a password and private key.
success = ssh.AuthenticatePwPk("myLogin","myPassword",key)
if (success == true)
    print "Authentication is successful!" + "\n";
    exit
end

# 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") + "\n";
print "authFailReason: " + json.stringOf("authFailReason") + "\n";