(SQL Server) ScMinidriver - Import a Certificate and Private Key to a Smart Card or USB Token

See more ScMinidriver Examples

Demonstrates how to import a certificate and its private key to a key container on a smart card or USB token.

Note: This functionality was introduced in Chilkat v9.5.0.87.

Note: The ScMinidriver functionality is for Windows-only because ScMinidriver DLLs only exist on Windows.

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

    -- To import a cert + private key, we'll need to be PIN authenticated.
    -- For more details about smart card PIN authentication, see the Smart Card PIN Authentication Example
    DECLARE @pinId nvarchar(4000)
    SELECT @pinId = 'user'
    DECLARE @retval int
    EXEC sp_OAMethod @scmd, 'PinAuthenticate', @retval OUT, @pinId, '000000'
    IF @retval <> 0
      BEGIN

        PRINT 'PIN Authentication failed.'
        EXEC sp_OAMethod @scmd, 'DeleteContext', @success OUT
        EXEC @hr = sp_OADestroy @scmd
        RETURN
      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

    -- Load the cert + private key from a .p12/.pfx
    -- We got this .p12 from https://badssl.com/download/
    DECLARE @password nvarchar(4000)
    SELECT @password = 'badssl.com'
    EXEC sp_OAMethod @cert, 'LoadPfxFile', @success OUT, 'qa_data/pfx/badssl.com-client.p12', @password
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @cert, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAMethod @scmd, 'DeleteContext', @success OUT
        EXEC @hr = sp_OADestroy @scmd
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    -- Let's import this certificate as the "signature" key/cert in key container #6.
    DECLARE @containerIndex int
    SELECT @containerIndex = 6
    DECLARE @keySpec nvarchar(4000)
    SELECT @keySpec = 'sig'
    EXEC sp_OAMethod @scmd, 'ImportCert', @success OUT, @cert, @containerIndex, @keySpec, @pinId
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @scmd, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END
    ELSE
      BEGIN

        PRINT 'Successfully imported the cert + private key onto the smart card.'
      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