React Native

FTP through SSH Tunnel

See more FTP Examples

Demonstrates how to FTP through an SSH tunnel.

The Chilkat SSH tunnel object is used to create a portable SSH tunnel w/ dynamic port forwarding on a background thread that the foreground thread can use for establishing connections through an SSH tunnel.

React Native

import { Ftp2, SshTunnel } from '@chilkat/react-native'

async function chilkatExample() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const tunnel = new SshTunnel();

  const sshHostname = 'sftp.example.com';
  const sshPort = 22;

  // Connect to an SSH server and establish the SSH tunnel:
  try {
    await tunnel.connectAsync(sshHostname, sshPort);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }

  // Authenticate with the SSH server via a login/password
  // or with a public key.  
  // This example demonstrates SSH password authentication.
  try {
    await tunnel.authenticatePwAsync('mySshLogin', 'mySshPassword');
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }

  // Indicate that the background SSH tunnel thread will behave as a SOCKS proxy server
  // with dynamic port forwarding:
  tunnel.dynamicPortForwarding = true;

  // We may optionally require that connecting clients authenticate with our SOCKS proxy server.
  // To do this, set an inbound username/password.  Any connecting clients would be required to 
  // use SOCKS5 with the correct username/password.
  // If no inbound username/password is set, then our SOCKS proxy server will accept both
  // SOCKS4 and SOCKS5 unauthenticated connections.

  tunnel.inboundSocksUsername = 'chilkat123';
  tunnel.inboundSocksPassword = 'password123';

  // Start the listen/accept thread to begin accepting SOCKS proxy client connections.
  // Listen on port 1080.
  try {
    await tunnel.beginAcceptingAsync(1080);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }

  // Now that a background thread is running a SOCKS proxy server that forwards connections
  // through an SSH tunnel, it is possible to use any Chilkat implemented protocol that is SOCKS capable,
  // such as Socket, HTTP, POP3, SMTP, IMAP, FTP, etc.  The protocol may use SSL/TLS because the SSL/TLS
  // will be passed through the SSH tunnel to the end-destination.  Also, any number of simultaneous
  // connections may be routed through the SSH tunnel.

  // Let's do an FTP upload through the SSH tunnel.  Both the control and data connections 
  // go through the tunnel.
  const ftp = new Ftp2();

  ftp.hostname = 'ftp.example.com';
  ftp.username = 'login';
  ftp.password = 'password';

  // Indicate that the FTP2 object is to use our portable SOCKS proxy/SSH tunnel running in our background thread.
  ftp.socksHostname = 'localhost';
  ftp.socksPort = 1080;
  ftp.socksVersion = 5;
  ftp.socksUsername = 'chilkat123';
  ftp.socksPassword = 'password123';

  // Connect to the FTP server
  try {
    await ftp.connectOnlyAsync();
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  // Authenticate with the FTP server.
  try {
    await ftp.loginAfterConnectOnlyAsync();
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  // Change to the remote directory where the file will be uploaded.
  try {
    await ftp.changeRemoteDirAsync('junk');
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  // Upload a file.
  const localPath = '/temp/hamlet.xml';
  const remoteFilename = 'hamlet.xml';

  try {
    await ftp.putFileAsync(localPath, remoteFilename);
  } catch {
    console.log(ftp.lastErrorText);
    return;
  }

  // This closes the SSH channel within the SSH tunnel,
  // and thus closes the connection with the FTP server.
  await ftp.disconnectAsync();

  console.log('File Uploaded!');

  // Stop the background listen/accept thread:
  const waitForThreadExit = true;
  try {
    tunnel.stopAccepting(waitForThreadExit);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }

  // Close the SSH tunnel (would also kick any remaining connected clients).
  try {
    tunnel.closeTunnel(waitForThreadExit);
  } catch {
    console.log(tunnel.lastErrorText);
    return;
  }
}