JavaScript

SFTP Public-Key Authentication

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using publickey authentication. JavaScript

var success = false;

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

var sftp = new CkSFtp();

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

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
var hostname = "sftp.example.com";
var port = 22;
success = sftp.Connect(hostname,port);
if (success !== true) {
    console.log(sftp.LastErrorText);
    return;
}

var key = new CkSshKey();

// Load a PEM file into a string variable:
// (This does not load the PEM file into the key.  The LoadText
// method is a convenience method for loading the full contents of ANY text
// file into a string variable.)
var privKey = key.LoadText("myPrivateKey.pem");
if (key.LastMethodSuccess !== true) {
    console.log(key.LastErrorText);
    return;
}

// Load a private key from a PEM string:
// (Private keys may be loaded from OpenSSH and Putty formats.
// Both encrypted and unencrypted private key file formats
// are supported.  This example loads an unencrypted private
// key in OpenSSH format.
success = key.FromOpenSshPrivateKey(privKey);
if (success !== true) {
    console.log(key.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!");