JavaScript

Connect to an SFTP Server

Demonstrates the Chilkat SFtp.Connect method, which establishes the SSH connection to an SFTP server. The first argument is the hostname (a DNS name or numeric IPv4/IPv6 address) and the second is the TCP port, usually 22. Connecting is the first of three setup steps.

Background: SFTP runs as a subsystem over SSH, so a session is set up in three fixed steps: Connect establishes the encrypted SSH transport, an Authenticate method logs in, and InitializeSftp opens the SFTP subsystem. File and directory operations are only possible after all three succeed.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the SFtp.Connect method, which establishes the SSH connection to an SFTP server.
//  The 1st argument is the hostname (a DNS name or numeric IP) and the 2nd is the TCP port.
//  
//  Connecting is only the first of three steps.  The full sequence is:
//    1. Connect
//    2. AuthenticatePw (or another authentication method)
//    3. InitializeSftp

var sftp = new CkSFtp();

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
var port = 22;
success = sftp.Connect("sftp.example.com",port);
if (success == false) {
    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.
var password = "mySshPassword";

success = sftp.AuthenticatePw("mySshLogin",password);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
success = sftp.InitializeSftp();
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("Connected, authenticated, and SFTP subsystem initialized.");

sftp.Disconnect();