(Node.js) SFTP Public-Key Authentication (id_ed25519)

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using publickey authentication with an Ed25519 private key (id_ed25519).

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 assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var key = new chilkat.SshKey();

    // The id_ed25519 file should contain something like this:
    // (You can open it in a text editor..)

    // -----BEGIN OPENSSH PRIVATE KEY-----
    // b3BlbnNzaC1rZXktdjEAAAAACmFlczI1Ni1jdHIAAAAGYmNyeXB0AAAAGAAAABDIeK9+Xw
    // 6Do9gnhtrJu5iJAAAAZAAAAAEAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIMh/Ge7fjQCssmVd
    // BqjYZbRAI0pY8IrnB6J1yLetq34OAAAAoMVP7cvy4hTiAINA3I4v55OonkpKza8mzfUW18
    // RDQeYL3ovCVaAYOGcCpf/SW3QiY6tnXq+5WDEfJ7Z/kQ0nl2+1wSLOytxpyO+IY0rRtLrX
    // 6e/agR4nbZpt/MFG6xqcNASbtDgg+9IWGvDrtXOLFofx07/zml+UjFL0tXRpCjOxeqKyXH
    // t8SRgdT97d9/bYPwapaXY+b2DVVy5/LVx4Sq8=
    // -----END OPENSSH PRIVATE KEY-----

    var privKeyText = key.LoadText("c:/temp/id_ed25519");
    if (key.LastMethodSuccess !== true) {
        console.log(key.LastErrorText);
        return;
    }

    // If your private key was saved encrypted, then you'll need the password.
    // In this example, the password "blahblah" is valid for the above key -- which is a real Ed25519 key generated/saved from puttygen.
    key.Password = "blahblah";

    var success = key.FromOpenSshPrivateKey(privKeyText);
    if (success !== true) {
        console.log(key.LastErrorText);
        return;
    }

    var sftp = new chilkat.SFtp();

    // Set some timeouts, in milliseconds:
    sftp.ConnectTimeoutMs = 5000;
    sftp.IdleTimeoutMs = 15000;

    var hostname = "sftp.example.com";
    var port = 22;
    var success = sftp.Connect(hostname,port);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  
    success = sftp.AuthenticatePk("myLogin",key);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log(sftp.LastErrorText);
    console.log("Public-Key Authentication Successful!");

    // Now go do whatever you're app needs to do...

}

chilkatExample();