JavaScript

SFTP Authenticate with a Private Key

Demonstrates the Chilkat SFtp.AuthenticatePk method, which authenticates the connected session using public-key authentication. The first argument is the username and the second is an SshKey private key. The matching public key must already be authorized for the account on the server.

Note: The private-key path is relative to the application's current working directory. Supply the path to your own key file.

Background: Public-key authentication is the standard for unattended SFTP transfers: the private key stays on the client, the server trusts the corresponding public key, and no reusable password crosses the wire. The SshKey object imports keys in several formats — this example loads an OpenSSH private key. For an encrypted key, set its Password property before importing.

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.

JavaScript

var success = false;

//  Demonstrates the SFtp.AuthenticatePk method, which authenticates the connected session using
//  public-key authentication.  The 1st argument is the username and the 2nd is an SshKey private
//  key.  The matching public key must already be authorized for the account on the server.

var sftp = new CkSFtp();

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
var port = 22;
success = sftp.Connect("sftp.example.com",port);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  Load the SSH private key.  LoadText reads the file's text, which is then imported.
var privKey = new CkSshKey();
var keyText = privKey.LoadText("qa_data/id_rsa");
if (privKey.LastMethodSuccess == false) {
    console.log(privKey.LastErrorText);
    return;
}

success = privKey.FromOpenSshPrivateKey(keyText);
if (success == false) {
    console.log(privKey.LastErrorText);
    return;
}

success = sftp.AuthenticatePk("mySshLogin",privKey);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
success = sftp.InitializeSftp();
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("Authenticated with a private key.");

sftp.Disconnect();