Lua

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. Lua

local chilkat = require("chilkat")

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

local scmd = chilkat.ScMinidriver.new()

-- Reader names (smart card readers or USB tokens) can be discovered
-- via List Readers or Find Smart Cards
local readerName = "Alcor Micro USB Smart Card Reader 0"
local success = scmd:acquire_context(readerName)
if not success then
    print(scmd.last_error_text)
    return
end

-- If we are successful, the name of the currently inserted smart card is available:
local cardName = scmd.card_name
print("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.
local pinId = "user"

-- Change this to the PIN for your smart card.
local pin = "0000"

local retval = scmd:pin_authenticate(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 then
    print(scmd.last_error_text)
    return
end

if retval > 0 then
    print("PIN authentcation failed, " .. retval .. " attempts remaining before the PIN is blocked.")
else
    print("PIN authentication successful. Your session is now authenticated and you may proceed with operations such as signing.")
end

-- ...
-- ...
-- ...

-- You may deauthenticate the session when finished with operations that required authentication.
success = scmd:pin_deauthenticate(pinId)
if not success then
    print(scmd.last_error_text)
end

-- Delete the context when finished with the card.
success = scmd:delete_context()
if not success then
    print(scmd.last_error_text)
end