(Node.js) SCP Download/Upload Binary Files as Encoded Strings

Demonstrates how to upload and download binary files as encoded strings (base64, hex, etc.) using the SCP protocol (Secure Copy Protocol over SSH).

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var ssh = new chilkat.Ssh();

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

    // Connect to an SSH server:
    var 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 chilkat.Scp();

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

    var remotePath = "images/starfish.jpg";

    // Download the binary file and return as a base64 string.
    // See <a href="http://www.cknotes.com/chilkat-binary-encoding-list/">List of Encodings</a> for a list of possible encodings.
    var encodedJpg = scp.DownloadBinaryEncoded(remotePath,"base64");
    if (scp.LastMethodSuccess !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    remotePath = "images/starfish2.jpg";

    // Now upload from the base64 string to the SSH server.
    // Insided the call to UploadBinaryEncoded, the base64 string is decoded,
    // and the decoded bytes are uploaded.  The resulting starfish2.jpg on the
    // server will be identical to the original starfish.jpg
    success = scp.UploadBinaryEncoded(remotePath,encodedJpg,"base64");
    if (success !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    console.log("SCP download/upload binary encoded success.");

    // Disconnect
    ssh.Disconnect();

}

chilkatExample();