(JavaScript) 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 Chilkat v11.0.0 or greater.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// 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.
var key = new CkSshKey();
key.Password = "key_password";

success = key.FromOpenSshPrivateKey(key.LoadText("qa_data/my_private_key_file"));
if (success == false) {
    console.log(key.LastErrorText);
    return;
}

var ssh = new CkSsh();

success = ssh.Connect("ssh.example.com",22);
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

// Authenticate using both a password and private key.
success = ssh.AuthenticatePwPk("myLogin","myPassword",key);
if (success == true) {
    console.log("Authentication is successful!");
    return;
}

// If we get here, it means the authentication failed.
// Examine the last JSON data to get information..

var json = new CkJsonObject();
ssh.GetLastJsonData(json);

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:
console.log("authResult: " + json.StringOf("authResult"));
console.log("authFailReason: " + json.StringOf("authFailReason"));