(Node.js) PKCS11 Certificate Chain

See more PKCS11 Examples

Demonstrates how to make CA certs available for the certificate chain to be included when creating a signature (using a PKCS11 compatible smart card / USB token) such as for PDF, XMLDSig, etc.

Note: This example requires Chilkat v9.5.0.88 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();

    // You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
    // On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
    // Otherwise provide the full path.
    pkcs11.SharedLibPath = "bit4xpki.dll";

    var success = pkcs11.Initialize();
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // Pass -1 for the slotID to open a session on the first non-empty slot.
    var slotID = -1;

    // Open a session.
    var readWrite = true;
    success = pkcs11.OpenSession(slotID,readWrite);
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    // Make it an authenticated session by calling Login.
    var userType = 1;
    // Make sure to use the correct PIN for your smart card..
    var pin = "0000";
    success = pkcs11.Login(userType,pin);
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        success = pkcs11.CloseSession();
        return;
    }

    // Get the certificate (on the smart card) that has a private key.
    var cert = new chilkat.Cert();
    success = pkcs11.FindCert("privateKey","",cert);
    if (success == true) {
        console.log("Cert with private key: " + cert.SubjectCN);
    }
    else {
        console.log("No certificates having a private key were found.");
        success = pkcs11.CloseSession();
        return;
    }

    // If the certificates in the chain of authentication were contained on the smart card,
    // then Chilkat would already have them (via the FindCert function) and the certs in the chain will be automatically used
    // as needed when signing occurs.

    // If you have CA certs located elsewhere, such as in .cer files, you can make them available to Chilkat in the following way:

    var certVault = new chilkat.XmlCertVault();
    // Please review the methods available in the XML certificate vault class.  Different methods exist for adding certificates
    // from various sources, such as PEM, PFX, or in-memory sources..
    success = certVault.AddCertFile("someDir/caIntermediateCert.cer");
    // ...
    success = certVault.AddCertFile("someDir/caCert.cer");
    // (Your code should check the return value to make sure it succeeded.)

    success = cert.UseCertVault(certVault);
    if (success == false) {
        console.log(cert.LastErrorText);
        success = pkcs11.CloseSession();
        return;
    }

    // --------------------------------------------------------------------------
    // At this point, we have the cert (and certs in the chain of authentication) to be used for signing.
    // The code for using the certificate in creating the digital signature, such as for a PDF, XML, etc., go here...

    // --------------------------------------------------------------------------

    // Revert to an unauthenticated session by calling Logout.
    success = pkcs11.Logout();
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        success = pkcs11.CloseSession();
        return;
    }

    // When finished, close the session.
    // It is important to close the session (memory leaks will occur if the session is not properly closed).
    success = pkcs11.CloseSession();
    if (success == false) {
        console.log(pkcs11.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();