(JavaScript) SCP Download Text File to String Variable

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable.

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 "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
var remotePath = "repository/xml/hamlet.xml";

// The byte representation of the remote text file (i.e. the charset) must be
// indicated to allow the receiving software to correctly interpret the incoming
// bytes as the correct chars.
// See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
var charset = "utf-8";

var fileContents = scp.DownloadString(remotePath,charset);
if (scp.LastMethodSuccess !== true) {
    console.log(scp.LastErrorText);
    return;
}

console.log("Received file:");
console.log(fileContents);

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

// Disconnect
ssh.Disconnect();