(Node.js) PKCS11 Generate a Session RSA Key on the HSM

See more PKCS11 Examples

Generates an RSA key on the smart card or token and returns the public and private key handles. The generated RSA key exists only for the duration of the PKCS11 session.

Note: This example requires Chilkat v9.5.0.96 or later.

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() {

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

    // Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

    var pkcs11 = new chilkat.Pkcs11();

    // Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
    // (The format of the path will change with the operating system.  Obviously, "C:/" is not used on non-Windows systems.
    pkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll";

    // Establish a logged-on session.
    var pin = "0000";
    var userType = 1;
    var success = pkcs11.QuickSession(userType,pin);
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // Specify attributes and abilities (how this key can be used) by providing a JSON template.
    // One template is for the public key, and the other for the private key.
    var pubKeyAttr = new chilkat.JsonObject();

    // Allow the public key to be used for encryption, signature verification, and symmetric key wrapping
    // These attributes are optional.
    pubKeyAttr.UpdateBool("encrypt",true);
    pubKeyAttr.UpdateBool("verify",true);
    pubKeyAttr.UpdateBool("wrap",true);

    // Generate a 2048-bit RSA key.
    // This attribute is required.
    pubKeyAttr.UpdateInt("modulus_bits",2048);

    var privKeyAttr = new chilkat.JsonObject();

    // Generate a session RSA key.
    // A session key exists only for the duration of the PKS11 session.
    // To generate an RSA key that resides on the HSM, set the "token" attribute equal to true
    privKeyAttr.UpdateBool("token",false);

    // Allow the private key to be used for signing and decryption.
    privKeyAttr.UpdateBool("sign",true);
    privKeyAttr.UpdateBool("decrypt",true);

    // Do not allow the private key to be extracted.
    privKeyAttr.UpdateBool("extractable",false);

    // Provide a JSON object to receive the public and private key handles.
    var jsonHandles = new chilkat.JsonObject();
    jsonHandles.EmitCompact = false;

    // Provide a Chilkat public key object to receive the public key.
    var pubKey = new chilkat.PublicKey();

    success = pkcs11.GenRsaKey(pubKeyAttr,privKeyAttr,jsonHandles,pubKey);
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        console.log("Failed to generate an RSA key.");
    }
    else {
        // Sample JSON handles:
        // {
        //   "public_key_handle": 18415630,
        //   "private_key_handle": 74842125
        // }
        console.log(jsonHandles.Emit());
        console.log("public_key_handle: " + jsonHandles.UIntOf("public_key_handle"));
        console.log("private_key_handle: " + jsonHandles.UIntOf("private_key_handle"));
        console.log("public key JWK:");
        console.log(pubKey.GetJwk());
        // Sample JWK:
        // {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
        console.log("Success.");
    }

    pkcs11.Logout();
    pkcs11.CloseSession();

}

chilkatExample();