JavaScript

SSH Public Key Authentication

See more SSH Examples

Demonstrates how to authenticate with an SSH server using public key authentication. JavaScript

var success = false;

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

var ssh = new CkSsh();

// Set some timeouts, in milliseconds:
ssh.ConnectTimeoutMs = 5000;
ssh.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 = ssh.Connect(hostname,port);
if (success !== true) {
    console.log(ssh.LastErrorText);
    return;
}

var key = new CkSshKey();

// Read the 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.  PuTTY keys typically use the .ppk
// file extension, while OpenSSH keys use the PEM format.
// (For PuTTY keys, call FromPuttyPrivateKey instead.)
success = key.FromOpenSshPrivateKey(privKey);
if (success !== true) {
    console.log(key.LastErrorText);
    return;
}

// Authenticate with the SSH server using the login and
// private key.  (The corresponding public key should've 
// been installed on the SSH server beforehand.)
success = ssh.AuthenticatePk("myLogin",key);
if (success !== true) {
    console.log(ssh.LastErrorText);
    return;
}

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