React Native

SFTP Authenticate with Password and Private Key

Demonstrates the Chilkat SFtp.AuthenticatePwPk method, which authenticates with a server that requires both a password and a private key. The arguments are the username, the password, and an SshKey private key.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: Most servers require either a password or a public key, not both — but some high-security deployments mandate two-factor SSH, combining something you know (the password) with something you have (the key). This method satisfies that policy in one call. As always, the password should come from a secure source rather than a literal in code.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { SFtp, SshKey } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the SFtp.AuthenticatePwPk method, which authenticates with a server that requires
  // BOTH a password and a private key.  The 1st argument is the username, the 2nd is the password,
  // and the 3rd is an SshKey private key.

  const sftp = new SFtp();

  // Step 1: Connect the SSH transport.  Port 22 is the usual port.
  const port = 22;
  try {
    await sftp.connectAsync('sftp.example.com', port);
  } catch {
    console.log(sftp.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';

  // Load the SSH private key.  LoadText reads the file's text, which is then imported.
  const privKey = new SshKey();
  let keyText: string;
  try {
    keyText = privKey.loadText('qa_data/id_rsa');
  } catch {
    console.log(privKey.lastErrorText);
    return;
  }

  try {
    privKey.fromOpenSshPrivateKey(keyText);
  } catch {
    console.log(privKey.lastErrorText);
    return;
  }

  try {
    await sftp.authenticatePwPkAsync('mySshLogin', password, privKey);
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  // Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
  // file or directory operations.
  try {
    await sftp.initializeSftpAsync();
  } catch {
    console.log(sftp.lastErrorText);
    return;
  }

  console.log('Authenticated with a password and a private key.');

  sftp.disconnect();
}