Node.js

SSH Keyboard Authentication

See more SSH Examples

Demonstrates how to implement keyboard authentication with an SSH server. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var ssh = new chilkat.Ssh();

    //  Set some timeouts, in milliseconds:
    ssh.ConnectTimeoutMs = 5000;
    ssh.IdleTimeoutMs = 15000;

    //  Connect to the SSH server.  
    //  The standard SSH port = 22
    //  The hostname may be a hostname or IP address.
    var hostname = "sftp.example.com";
    var port = 22;
    success = ssh.Connect(hostname,port);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Begin keyboard authentication..
    var xmlResponse = ssh.StartKeyboardAuth("myLogin");
    if (ssh.LastMethodSuccess !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  If a user authentication banner was received, then your app
    //  may display it prior to prompting for the password.
    console.log("UserAuthBanner: " + ssh.UserAuthBanner);

    var xml = new chilkat.Xml();

    success = xml.LoadXml(xmlResponse);
    //  Assume LoadXml succeeds for the example..
    if (xml.HasChildWithTag("success") == true) {
        console.log("No password required, already authenticated.");
        return;
    }

    if (xml.HasChildWithTag("error") == true) {
        console.log("Authentication already failed.");
        return;
    }

    //  See the online reference documentation for Chilkat SSH.
    //  The XML returned by StartKeyboardAuth will contain an infoRequest
    //  with one or more prompts that your application may choose to display.

    //  Call ContinueKeyboardAuth, passing in the whatever information is requires (such as the password).
    //  Typically, keyboard authentication requires one call to ContinueKeyboardAuth 
    //  using the password.  Theoretically, the SSH server could prompt for additional pieces
    //  of information.  The authentication is completed when the XML returned contains
    //  either a "success" or "error" child node.

    //  This example asumes only one call to ContinueKeyboardAuth is required.
    xmlResponse = ssh.ContinueKeyboardAuth("myPassword");
    if (ssh.LastMethodSuccess !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    success = xml.LoadXml(xmlResponse);
    //  Assume LoadXml succeeds for the example..
    if (xml.HasChildWithTag("success") == true) {
        console.log("SSH Keyboard Authentication Successful!");
        return;
    }

    if (xml.HasChildWithTag("error") == true) {
        console.log("Authentication failed.");
        return;
    }


}

chilkatExample();