(Node.js) PKCS11 Find Private Key by Label

See more PKCS11 Examples

Demonstrates how to find a private key based on a user-specified label.

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, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

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.
    // For example:
    pkcs11.SharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll";

    // Use your HSM's PIN.
    var pin = "0000";

    // Normal user = 1
    var userType = 1;

    // Establish a logged-on user session with the HSM.
    var success = pkcs11.QuickSession(userType,pin);
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // Provide a template to find a PKCS11 object.
    var jsonTemplate = new chilkat.JsonObject();

    // Find an RSA private key with the label "MySshKey".
    // Here's an example of how the key was originally imported: 
    // PKCS11 Import SSH Key
    jsonTemplate.UpdateString("class","private_key");
    jsonTemplate.UpdateString("key_type","rsa");
    jsonTemplate.UpdateString("label","MySshKey");

    var privKeyHandle = pkcs11.FindObject(jsonTemplate);
    if (privKeyHandle == 0) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // The private key handle is only valid during the PKCS11 session.
    // If you wish to use the private key in another PKCS11 session,
    // you'll first need to find it.  See:  
    console.log("private key handle: " + privKeyHandle);

    // Do whatever you wish with the private key handle...
    // ...
    // ...

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

}

chilkatExample();