Sample code for 30+ languages & platforms
JavaScript

SCP Download File

See more SCP Examples

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH).
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;

// 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;
}

var remotePath = "test.txt";
var localPath = "/home/bob/test.txt";
success = scp.DownloadFile(remotePath,localPath);
if (success !== true) {
    console.log(scp.LastErrorText);
    return;
}

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

// Disconnect
ssh.Disconnect();