(SQL Server) Load Certificate from Smart Card by Key Usage

See more Certificates Examples

You may have a smartcard or USB token that contains only 2 certificates, one for signing, and one for authentication, and you wish to load the certificate for signing. This example demonstrates how to load the 1st certificate found on a smartcard that matches the intended key usage.

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)
    DECLARE @sTmp1 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

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

    -- If you know the smart card PIN, set it prior to loading from the smartcard/USB token.
    EXEC sp_OASetProperty @cert, 'SmartCardPin', '12345678'

    -- To load a certificate matching an intended key usage, specify the type of usage as shown below.
    -- 
    -- The possible key usage keywords are:
    -- 
    -- digitalsignature
    -- Use when the public key is used with a digital signature mechanism to support security services other than non-repudiation, certificate signing, or CRL signing. 
    -- A digital signature is often used for entity authentication and data origin authentication with integrity.

    -- nonrepudiation
    -- When a digital certificate's key usage includes "nonrepudiation," it implies that the certificate and its associated private key can be used to 
    -- create digital signatures that provide proof of the origin and integrity of the signed data, and the signer cannot later deny having signed the data.

    -- Other less common usages:

    -- certificatesigning
    -- keyencipherment
    -- dataencipherment
    -- crlsigning
    -- secureemail
    -- serverauthentication
    -- clientauthentication
    -- codesigning
    -- timestamping

    DECLARE @success int
    EXEC sp_OAMethod @cert, 'LoadFromSmartcard', @success OUT, 'keyusage=nonrepudiation'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @cert, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Certificate not loaded.'
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END


    EXEC sp_OAGetProperty @cert, 'SubjectDN', @sTmp0 OUT

    EXEC sp_OAGetProperty @cert, 'SerialNumber', @sTmp1 OUT
    PRINT 'Found: ' + @sTmp0 + ' serial=' + @sTmp1

    EXEC @hr = sp_OADestroy @cert


END
GO