React Native

Get SSH Server Authentication Methods

Demonstrates getting the authentication methods advertised by an SSH server. Connect first but do not authenticate, then call GetAuthMethods, which returns a lowercase, comma-separated list such as publickey,password,keyboard-interactive.

Important: Querying the authentication methods intentionally disconnects from the server, so reconnect before authenticating.

Background: Knowing what a server accepts lets a client choose the right authentication path rather than guessing — for example, falling back to keyboard-interactive when password authentication is not offered, or failing fast with a clear message when only public-key is allowed. It is also useful diagnostically when authentication fails for reasons that are not obvious from the error text.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { Ssh } 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 getting the authentication methods advertised by an SSH server.

  const ssh = new Ssh();

  const port = 22;

  // The server must be connected, but not yet authenticated.
  try {
    await ssh.connectAsync('ssh.example.com', port);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // Returns a lowercase, comma-separated list, such as:
  //     publickey,password,keyboard-interactive
  let authMethods: string;
  try {
    authMethods = await ssh.getAuthMethodsAsync();
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(`Authentication methods supported by this server: ${authMethods}`);

  // IMPORTANT: Querying the authentication methods intentionally disconnects from the server.
  // Reconnect before authenticating.
  try {
    await ssh.connectAsync('ssh.example.com', port);
  } catch {
    console.log(ssh.lastErrorText);
    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';

  try {
    await ssh.authenticatePwAsync('mySshLogin', password);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log('SSH authentication successful.');

  ssh.disconnect();
}