(SQL Server) ScMinidriver - Load Certificate from Smart Card or USB Token by Index

See more ScMinidriver Examples

Demonstrates how to load a certificate located on a smart card or USB token by key container index.

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 = 'SCM Microsystems Inc. SCR33x 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 successful, the name of the currently inserted smart card is available:

    EXEC sp_OAGetProperty @scmd, 'CardName', @sTmp0 OUT
    PRINT 'Card name: ' + @sTmp0

    -- If desired, perform regular PIN authentication with the smartcard.
    -- For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
    DECLARE @retval int
    EXEC sp_OAMethod @scmd, 'PinAuthenticate', @retval OUT, 'user', '000000'
    IF @retval <> 0
      BEGIN

        PRINT 'PIN Authentication failed.'
      END

    DECLARE @cert int
    -- Use "Chilkat_9_5_0.Cert" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Cert', @cert OUT

    -- We can pass a specific key container index, or -1 to locate the 1st non-empty container containing a certificate and private key.
    DECLARE @keyContainerIndex int
    SELECT @keyContainerIndex = -1
    -- keySpec can be "kex" or "sig" to indicate the key-exchange or signature position within the container.
    -- keySpec can also be "any" to accept either position, with preference given to the "sig" position if both are occupied.
    DECLARE @keySpec nvarchar(4000)
    SELECT @keySpec = 'any'
    EXEC sp_OAMethod @scmd, 'GetCert', @success OUT, @keyContainerIndex, @keySpec, @cert
    IF @success = 0
      BEGIN

        PRINT 'Failed to load the certificate.'
      END
    ELSE
      BEGIN

        PRINT 'Successfully loaded the cert object from the smart card / USB token.'

        -- Note: When successful, the cert object is internally linked to the ScMinidriver object's authenticated session.
        -- The cert object can now be used to sign or do other cryptographic operations that occur on the smart card / USB token.
        -- If your application calls PinDeauthenticate or DeleteContext, the cert will no longer be able to sign on the smart card
        -- because the smart card ScMinidriver session will no longer be authenticated or deleted.
      END

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

    -- When finished with operations that required authentication, you may if you wish, deauthenticate the session.
    EXEC sp_OAMethod @scmd, 'PinDeauthenticate', @success OUT, 'user'
    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
    EXEC @hr = sp_OADestroy @cert


END
GO