React Native

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 React Native Downloads

Download Chilkat for React Native

React Native

import { Ssh, Xml } from '@chilkat/react-native'

async function chilkatExample() {
  // 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.

  const ssh = new Ssh();

  ssh.connectTimeoutMs = 5000;
  ssh.readTimeoutMs = 15000;

  const hostname = 'ssh.example.com';
  const port = 22;
  try {
    await ssh.connectAsync(hostname, port);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // Begin keyboard-interactive authentication.  The returned XML describes the server's prompts.
  let xmlResponse: string;
  try {
    xmlResponse = await ssh.startKeyboardAuthAsync('mySshLogin');
  } catch {
    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}`);

  const xml = new Xml();
  try {
    xml.loadXml(xmlResponse);
  } catch {
    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.
  const 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".
  try {
    xmlResponse = await ssh.continueKeyboardAuthAsync(password);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    xml.loadXml(xmlResponse);
  } catch {
    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.');
  }
}