(Node.js) Generate RSA SSH Key

See more SSH Key Examples

Generates an RSA SSH key and saves to various public and private key file formats (OpenSSH and PuTTY).

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    var key = new chilkat.SshKey();

    // numBits may range from 384 to 4096.  Typical values are
    // 1024 or 2048.  (must be a multiple of 64)
    // A good choice for the exponent is 65537.  Chilkat recommends
    // always using this value.
    var numBits = 2048;
    var exponent = 65537;
    var success = key.GenerateRsaKey(numBits,exponent);
    if (success !== true) {
        console.log("Bad params passed to RSA key generation method.");
        return;
    }

    // Note: Generating a public/private key pair is CPU intensive
    // and may take a short amount of time (more than few seconds,
    // but less than a minute).

    var exportedKey;
    var exportEncrypted;

    // Export the RSA private key to OpenSSH, PuTTY, and XML and save. 
    exportEncrypted = false;
    exportedKey = key.ToOpenSshPrivateKey(exportEncrypted);
    // Chilkat provides a SaveText method for convenience...
    success = key.SaveText(exportedKey,"privkey_openssh_unencrypted.pem");

    // Export with encryption to OpenSSH private key format:
    key.Password = "secret";
    exportEncrypted = true;
    exportedKey = key.ToOpenSshPrivateKey(exportEncrypted);
    success = key.SaveText(exportedKey,"privkey_openssh_encrypted.pem");

    // Export the RSA private key to unencrypted PuTTY format:
    exportEncrypted = false;
    exportedKey = key.ToPuttyPrivateKey(exportEncrypted);
    success = key.SaveText(exportedKey,"privkey_putty_unencrypted.ppk");

    // Export the RSA private key to encrypted PuTTY format:
    key.Password = "secret";
    exportEncrypted = true;
    exportedKey = key.ToPuttyPrivateKey(exportEncrypted);
    success = key.SaveText(exportedKey,"privkey_putty_encrypted.ppk");

    // Export private key to XML:
    exportedKey = key.ToXml();
    success = key.SaveText(exportedKey,"privkey.xml");

    // ----------------------------------------------------
    // Now for the public key....
    // ----------------------------------------------------

    // The Secure Shell (SSH) Public Key File Format
    // is documented in RFC 4716.
    exportedKey = key.ToRfc4716PublicKey();
    success = key.SaveText(exportedKey,"pubkey_rfc4716.pub");

    // OpenSSH has a separate public-key file format, which 
    // is also supported by Chilkat SshKey:
    exportedKey = key.ToOpenSshPublicKey();
    success = key.SaveText(exportedKey,"pubkey_openSsh.pub");

    console.log("Finished.");

}

chilkatExample();