(Node.js) ScMinidriver - PIN Authentication for Smart Card or USB Token

See more ScMinidriver Examples

Demonstrates how to PIN authenticate with a connected smart card or USB token.

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.

    var scmd = new chilkat.ScMinidriver();

    // Reader names (smart card readers or USB tokens) can be discovered
    // via List Readers or Find Smart Cards
    var readerName = "Alcor Micro USB Smart Card Reader 0";
    var success = scmd.AcquireContext(readerName);
    if (success == false) {
        console.log(scmd.LastErrorText);
        return;
    }

    // If we are successful, the name of the currently inserted smart card is available:
    var cardName = scmd.CardName;
    console.log("Card name: " + cardName);

    // Perform regular PIN authentication with the smartcard.
    // If authentication is successful, then the ScMinidriver session is authenticated and
    // operations such as signing are permissible.

    // The pin ID can be "user", "admin", or a number "3" through "7" (passed as a string).
    // The possible pin ID's for a given smartcard are obtained via the GetCardProperties method.
    // See Get Smart Card Properties for sample code.
    // You should generally use the "user" pin ID.  You would only use the other pin ID's for very specific purposes.
    var pinId = "user";

    // Change this to the PIN for your smart card.
    var pin = "0000";

    var retval = scmd.PinAuthenticate(pinId,pin);

    // The return value is 0 for success.
    // If the retval is greater than 0, it is the number of attempts remaining before the PIN is blocked.
    // If the retval equals -1, then something else went wrong and you should consult the LastErrorText.
    if (retval < 0) {
        console.log(scmd.LastErrorText);
        return;
    }

    if (retval > 0) {
        console.log("PIN authentcation failed, " + retval + " attempts remaining before the PIN is blocked.");
    }
    else {
        console.log("PIN authentication successful. Your session is now authenticated and you may proceed with operations such as signing.");
    }

    // ...
    // ...
    // ...

    // You may deauthenticate the session when finished with operations that required authentication.
    success = scmd.PinDeauthenticate(pinId);
    if (success == false) {
        console.log(scmd.LastErrorText);
    }

    // Delete the context when finished with the card.
    success = scmd.DeleteContext();
    if (success == false) {
        console.log(scmd.LastErrorText);
    }


}

chilkatExample();