Ruby

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

require 'chilkat'

success = false

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

scmd = Chilkat::CkScMinidriver.new()

# Reader names (smart card readers or USB tokens) can be discovered
# via List Readers or Find Smart Cards
readerName = "Alcor Micro USB Smart Card Reader 0"
success = scmd.AcquireContext(readerName)
if (success == false)
    print scmd.lastErrorText() + "\n";
    exit
end

# If we are successful, the name of the currently inserted smart card is available:
cardName = scmd.cardName()
print "Card name: " + cardName + "\n";

# 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.
pinId = "user"

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

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)
    print scmd.lastErrorText() + "\n";
    exit
end

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

# ...
# ...
# ...

# You may deauthenticate the session when finished with operations that required authentication.
success = scmd.PinDeauthenticate(pinId)
if (success == false)
    print scmd.lastErrorText() + "\n";
end

# Delete the context when finished with the card.
success = scmd.DeleteContext()
if (success == false)
    print scmd.lastErrorText() + "\n";
end