JavaScript

Get the SFTP Server Host Key Fingerprint

Demonstrates the Chilkat SFtp.GetHostKeyFP method, which returns the connected server's host-key fingerprint. The first argument is the hash algorithm (for example SHA256 or MD5), the second controls whether the key type is included, and the third controls whether the hash name is included.

Background: The host-key fingerprint identifies the server. Comparing it against a known-good value is how a client implements host-key pinning — detecting a man-in-the-middle attempt or a changed server key before trusting the connection with credentials or files. SHA256 is the modern default; MD5 fingerprints still appear in older tooling but are weaker.

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.GetHostKeyFP method, which returns the server's host-key fingerprint.
//  The 1st argument is the hash algorithm, the 2nd controls whether the key type is included, and
//  the 3rd controls whether the hash name is included.

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

//  Get the SHA256 fingerprint, including the key type and hash name.
var includeKeyType = true;
var includeHashName = true;
var fingerprint = sftp.GetHostKeyFP("SHA256",includeKeyType,includeHashName);
if (sftp.LastMethodSuccess == false) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("Host key fingerprint: " + fingerprint);

sftp.Disconnect();