React Native

Initialize the SFTP Subsystem

Demonstrates the Chilkat SFtp.InitializeSftp method, which opens the SFTP subsystem and negotiates the SFTP protocol version. It takes no arguments and must be called after connecting and authenticating, before any file or directory operation.

Background: SFTP is not a standalone protocol but a subsystem requested over an authenticated SSH session, which is why this separate step exists. It is also where the SFTP protocol version is negotiated — that version determines which capabilities (such as certain timestamp and path-composition features) are available for the session. Skipping this call, or calling it before authentication, leaves every file operation failing.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the SFtp.InitializeSftp method, which opens the SFTP subsystem and negotiates the
  // SFTP protocol version.  It takes no arguments and must be called after connecting and
  // authenticating, before any file or directory operations.

  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('The SFTP subsystem is ready.');

  sftp.disconnect();
}