Node.js

SFTP Authentication using X.509 Certificates

See more SFTP Examples

Demonstrates how to authenticate with an SSH/SFTP server using an certificate's private key.

Note: See X.509v3 Certificates for SSH Authentication for more information.

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var sftp = new chilkat.SFtp();

    var hostname = "sftp.example.com";
    var port = 22;
    success = sftp.Connect(hostname,port);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    //  Load the cert + private key from a .pfx.
    //  Note: Chilkat provides methods for loading certs and private keys from many sources, including smart cards and USB tokens (HSM's)
    var cert = new chilkat.Cert();
    success = cert.LoadPfxFile("qa_data/pfx/example.pfx","pfx_password");
    if (success !== true) {
        console.log(cert.LastErrorText);
        return;
    }

    //  Get the cert's private key (as PEM) to be used for SSH authentication.
    //  (The public key is installed on the server.)
    var privKeyPem = cert.GetPrivateKeyPem();
    if (cert.LastMethodSuccess == false) {
        console.log(cert.LastErrorText);
        return;
    }

    var key = new chilkat.SshKey();

    //  Load a private key from a PEM string:
    success = key.FromOpenSshPrivateKey(privKeyPem);
    if (success !== true) {
        console.log(key.LastErrorText);
        return;
    }

    //  Authenticate with the SSH server.
    success = sftp.AuthenticatePk("myLogin",key);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

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

}

chilkatExample();