Node.js

SSH Keyboard-Interactive Authentication

Demonstrates keyboard-interactive authentication with an SSH server. StartKeyboardAuth returns XML describing the server's prompts, and ContinueKeyboardAuth submits each response. Authentication is complete when the returned XML contains either a success or an error node.

Background: Keyboard-interactive is SSH's flexible, prompt-driven method: rather than assuming a single password, the server asks one or more questions — a password, a one-time code, a security question — and the client answers each. This is how SSH supports two-factor and other challenge-response schemes. The prompt XML also indicates whether each response should be echoed, so a client knows when to mask input. A server may issue several rounds, so a robust implementation loops until it sees success or error rather than assuming one exchange is enough.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    //  Demonstrates keyboard-interactive authentication with an SSH server.  The server sends one or
    //  more prompts as XML, and the application answers each with ContinueKeyboardAuth.

    var ssh = new chilkat.Ssh();

    ssh.ConnectTimeoutMs = 5000;
    ssh.ReadTimeoutMs = 15000;

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

    //  Begin keyboard-interactive authentication.  The returned XML describes the server's prompts.
    var xmlResponse = ssh.StartKeyboardAuth("mySshLogin");
    if (ssh.LastMethodSuccess == false) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  If the server sent a user authentication banner, an application may display it before
    //  prompting.
    console.log("UserAuthBanner: " + ssh.UserAuthBanner);

    var xml = new chilkat.Xml();
    success = xml.LoadXml(xmlResponse);
    if (success == false) {
        console.log(xml.LastErrorText);
        return;
    }

    //  Authentication is complete when the XML contains either a "success" or an "error" node.
    if (xml.HasChildWithTag("success")) {
        console.log("No password required, already authenticated.");
        return;
    }

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

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    var password = "mySshPassword";

    //  Answer the prompt.  Typically one call is enough, but a server may issue several rounds of
    //  prompts, so a robust client loops until it sees "success" or "error".
    xmlResponse = ssh.ContinueKeyboardAuth(password);
    if (ssh.LastMethodSuccess == false) {
        console.log(ssh.LastErrorText);
        return;
    }

    success = xml.LoadXml(xmlResponse);
    if (success == false) {
        console.log(xml.LastErrorText);
        return;
    }

    if (xml.HasChildWithTag("success")) {
        console.log("SSH keyboard-interactive authentication successful.");
        return;
    }

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


}

chilkatExample();