(JavaScript) SCP Download from a Specific Directory

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to open and read the file in the specified directory.

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.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var ssh = new CkSsh();

// Hostname may be an IP address or hostname:
var hostname = "www.some-ssh-server.com";
var port = 22;

// Connect to an SSH server:
success = ssh.Connect(hostname,port);
if (success !== true) {
    console.log(ssh.LastErrorText);
    return;
}

// Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000;

// Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword");
if (success !== true) {
    console.log(ssh.LastErrorText);
    return;
}

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
var scp = new CkScp();

success = scp.UseSsh(ssh);
if (success !== true) {
    console.log(scp.LastErrorText);
    return;
}

// This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
// For example, if the HOME directory is /Users/chilkat, then the following downloads
// /Users/chilkat/testApp/logs/test1.log
var remotePath = "testApp/logs/test1.log";
var localPath = "c:/testApp/logs/test1.log";
success = scp.DownloadFile(remotePath,localPath);
if (success !== true) {
    console.log(scp.LastErrorText);
    return;
}

// The following call to DownloadFile specifies an absolute file path on the SSH server:
remotePath = "/Users/chilkat/Documents/gecko.jpg";
localPath = "c:/temp/images/gecko.jpg";
success = scp.DownloadFile(remotePath,localPath);
if (success !== true) {
    console.log(scp.LastErrorText);
    return;
}

console.log("SCP download file success.");

// Disconnect
ssh.Disconnect();