SFTP Authenticate with a SecureString Password and Private Key

See more SFTP Examples

Demonstrates the Chilkat SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login and password objects together with a private key. The third argument is the 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.

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

async function chilkatExample() {
  // Demonstrates the SFtp.AuthenticateSecPwPk method, which authenticates using SecureString login
  // and password objects together with 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;
  }

  // Place the login and password into SecureString objects.
  const secureLogin = new SecureString();
  secureLogin.append('mySshLogin');
  const securePassword = new SecureString();
  securePassword.append(password);

  try {
    await sftp.authenticateSecPwPkAsync(secureLogin, securePassword, 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.');

  sftp.disconnect();
}