Java

SSH Keyboard Authentication

See more SSH Examples

Demonstrates how to implement keyboard authentication with an SSH server. Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

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

    CkSsh ssh = new CkSsh();

    // Set some timeouts, in milliseconds:
    ssh.put_ConnectTimeoutMs(5000);
    ssh.put_IdleTimeoutMs(15000);

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    String hostname = "sftp.example.com";
    int port = 22;
    success = ssh.Connect(hostname,port);
    if (success != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    // Begin keyboard authentication..
    String xmlResponse = ssh.startKeyboardAuth("myLogin");
    if (ssh.get_LastMethodSuccess() != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

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

    CkXml xml = new CkXml();

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

    if (xml.HasChildWithTag("error") == true) {
        System.out.println("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.get_LastMethodSuccess() != true) {
        System.out.println(ssh.lastErrorText());
        return;
        }

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

    if (xml.HasChildWithTag("error") == true) {
        System.out.println("Authentication failed.");
        return;
        }
  }
}