Sample code for 30+ languages & platforms
React Native

SFTP Authenticate with a Password

See more SFTP Examples

Demonstrates the Chilkat SFtp.AuthenticatePw method, which authenticates the connected session with a login name and password. The first argument is the login and the second is the password. Call Connect first and InitializeSftp afterward.

Background: Password authentication is the simplest SFTP method, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for automated jobs. Note the fixed ordering: authentication happens between Connect and InitializeSftp.

Chilkat React Native Downloads

React Native
import { SFtp } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the SFtp.AuthenticatePw method, which authenticates the connected session with a
  // login name and password.  The 1st argument is the login and the 2nd is the password.

  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';

  try {
    await sftp.authenticatePwAsync('mySshLogin', password);
  } 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.');

  sftp.disconnect();
}