JavaScript

SFTP Authenticate with a Password

Demonstrates the Chilkat SFtp.AuthenticatePw method, which authenticates the connected session with a login name and password. The first argument is the login and the second is the password. Call Connect first and InitializeSftp afterward.

Background: Password authentication is the simplest SFTP method, but the password is a secret and should never be a hard-coded literal — obtain it from an interactive prompt, an environment variable, or a secrets vault. Public-key authentication is generally preferred for automated jobs. Note the fixed ordering: authentication happens between Connect and InitializeSftp.

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.AuthenticatePw method, which authenticates the connected session with a
//  login name and password.  The 1st argument is the login and the 2nd is the password.

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;
}

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
var password = "mySshPassword";

success = sftp.AuthenticatePw("mySshLogin",password);
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 password.");

sftp.Disconnect();