(Node.js) 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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

function chilkatExample() {

    // 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 chilkat.SshKey();
    key.Password = "key_password";

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

    var ssh = new chilkat.Ssh();

    success = ssh.Connect("ssh.example.com",22);
    if (success !== true) {
        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.
    // To find out why, get the LastJsonData
    // This is a feature added in Chilkat v9.5.0.79

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


}

chilkatExample();