(SQL Server) PKCS11 Login / Logout

See more PKCS11 Examples

Sample code showing how to login and logout of a PKCS11 session. A session becomes authenticated when Login is called, and returns to the unauthenticated state when Logout is called. A smart card's PIN is passed to the Login method.

Note: This example requires Chilkat v9.5.0.88 or later.

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
    DECLARE @iTmp0 int
    DECLARE @sTmp0 nvarchar(4000)
    -- 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.

    DECLARE @pkcs11 int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Pkcs11', @pkcs11 OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- "aetpkss1.dll" is the DLL for the SafeSign Identity Client Standard Version 3.5
    -- The aetpkss1.dll can be used with the following smart cards or USB tokens:
    -- Defensiepas
    -- Defensiepas 2
    -- G&D Convego Join 4.01 40k/80k
    -- G&D SkySIM Hercules
    -- G&D SkySIM Scorpius
    -- G&D Sm@rtCaf Expert 3.2
    -- G&D Sm@rtCaf Expert 4.0
    -- G&D Sm@rtCaf Expert 5.0
    -- G&D Sm@rtCaf Expert 6.0
    -- G&D Sm@rtCaf Expert 7.0
    -- G&D Sm@rtCaf Expert 64
    -- Gemalto Desineo ICP D72 FXR1 Java
    -- Gemalto IDCore 30
    -- Gemalto MultiApp ID v2.1
    -- Gemalto Optelio D72 FR1
    -- Gemalto TOP DL v2
    -- Infineon Oracle JCOS Ed.1
    -- JCOP21 v2.3
    -- Morpho IDealCitiz v2.1
    -- Morpho JMV ProCL V3.0
    -- NXP J2A080 / J2A081 (JCOP 2.4.1 R3)
    -- NXP JD081 (JCOP 2.4.1 R3)
    -- NXP J3A080 (JCOP 2.4.1 R3)
    -- NXP JCOP 2.4.2 R3
    -- NXP JCOP 3 SecID P60
    -- Oberthur IDOne Cosmo v7.0
    -- RDW ABR kaart
    -- Rijkspas
    -- Rijkspas 2
    -- Sagem YpsID s2
    -- Sagem YpsID s3
    -- StarSign Crypto USB Token S
    -- Swissbit PS-100u SE
    -- UZI-pas
    -- UZI-pas 2
    EXEC sp_OASetProperty @pkcs11, 'SharedLibPath', 'aetpkss1.dll'

    DECLARE @success int
    EXEC sp_OAMethod @pkcs11, 'Initialize', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pkcs11
        RETURN
      END

    -- We need to call Discover to get the slot ID.
    DECLARE @onlyTokensPresent int
    SELECT @onlyTokensPresent = 1
    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @pkcs11, 'Discover', @success OUT, @onlyTokensPresent, @json
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pkcs11
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OASetProperty @json, 'EmitCompact', 0
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- Make sure we have at least one slot.
    EXEC sp_OAMethod @json, 'SizeOfArray', @iTmp0 OUT, 'slot'
    IF @iTmp0 <= 0
      BEGIN

        PRINT 'No occuplied slots.'
        EXEC @hr = sp_OADestroy @pkcs11
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- Get the ID of the 1st slot
    DECLARE @slotID int
    EXEC sp_OAMethod @json, 'IntOf', @slotID OUT, 'slot[0].id'

    -- Open a session.
    DECLARE @readWrite int
    SELECT @readWrite = 1
    EXEC sp_OAMethod @pkcs11, 'OpenSession', @success OUT, @slotID, @readWrite
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pkcs11
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- Make it an authenticated session by calling Login.
    -- The smart card PIN is passed to the Login method.
    -- The user type can be one of three choices:
    -- 0 - Security Officer
    -- 1 - Normal User
    -- 2 - Context Specific.
    -- You'll likely always login as the Normal User.
    DECLARE @userType int
    SELECT @userType = 1
    DECLARE @pin nvarchar(4000)
    SELECT @pin = '0000'
    EXEC sp_OAMethod @pkcs11, 'Login', @success OUT, @userType, @pin
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAMethod @pkcs11, 'CloseSession', @success OUT
        EXEC @hr = sp_OADestroy @pkcs11
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- Do what is needed with the authenticated session...
    -- ...
    -- ...

    -- Revert to an unauthenticated session by calling Logout.
    EXEC sp_OAMethod @pkcs11, 'Logout', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAMethod @pkcs11, 'CloseSession', @success OUT
        EXEC @hr = sp_OADestroy @pkcs11
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- When finished, close the session.
    -- It is important to close the session (memory leaks will occur if the session is not properly closed).
    EXEC sp_OAMethod @pkcs11, 'CloseSession', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pkcs11
        EXEC @hr = sp_OADestroy @json
        RETURN
      END


    PRINT 'PKCS11 Login and Logout successfully demonstrated.'

    EXEC @hr = sp_OADestroy @pkcs11
    EXEC @hr = sp_OADestroy @json


END
GO