(SQL Server) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @scmd int
    -- Use "Chilkat_9_5_0.ScMinidriver" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.ScMinidriver', @scmd OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Reader names (smart card readers or USB tokens) can be discovered
    -- via List Readers or Find Smart Cards
    DECLARE @readerName nvarchar(4000)
    SELECT @readerName = 'Alcor Micro USB Smart Card Reader 0'
    DECLARE @success int
    EXEC sp_OAMethod @scmd, 'AcquireContext', @success OUT, @readerName
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @scmd, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @scmd
        RETURN
      END

    -- If we are successful, the name of the currently inserted smart card is available:
    DECLARE @cardName nvarchar(4000)
    EXEC sp_OAGetProperty @scmd, 'CardName', @cardName OUT

    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.
    DECLARE @pinId nvarchar(4000)
    SELECT @pinId = 'user'

    -- Change this to the PIN for your smart card.
    DECLARE @pin nvarchar(4000)
    SELECT @pin = '0000'

    DECLARE @retval int
    EXEC sp_OAMethod @scmd, 'PinAuthenticate', @retval OUT, @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
      BEGIN
        EXEC sp_OAGetProperty @scmd, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @scmd
        RETURN
      END

    IF @retval > 0
      BEGIN


        PRINT 'PIN authentcation failed, ' + @retval + ' attempts remaining before the PIN is blocked.'
      END
    ELSE
      BEGIN

        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.
    EXEC sp_OAMethod @scmd, 'PinDeauthenticate', @success OUT, @pinId
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @scmd, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END

    -- Delete the context when finished with the card.
    EXEC sp_OAMethod @scmd, 'DeleteContext', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @scmd, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END

    EXEC @hr = sp_OADestroy @scmd


END
GO