SQL Server
SQL Server
PKCS11 Generate a RSA Key that stays on the HSM
See more PKCS11 Examples
Generates an RSA key on the smart card or token and returns the public and private key handles. The generated RSA key stays on the HSM even after the PKCS11 session has ended.Note: This example requires Chilkat v9.5.0.96 or later.
Chilkat SQL Server Downloads
-- 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
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- 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.Pkcs11', @pkcs11 OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
-- (The format of the path will change with the operating system. Obviously, "C:/" is not used on non-Windows systems.
EXEC sp_OASetProperty @pkcs11, 'SharedLibPath', 'C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll'
-- Establish a logged-on session.
-- Use your actual PIN here.
DECLARE @pin nvarchar(4000)
SELECT @pin = '0000'
DECLARE @userType int
SELECT @userType = 1
EXEC sp_OAMethod @pkcs11, 'QuickSession', @success OUT, @userType, @pin
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @pkcs11
RETURN
END
-- Specify attributes and abilities (how this key can be used) by providing a JSON template.
-- One template is for the public key, and the other for the private key.
DECLARE @pubKeyAttr int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @pubKeyAttr OUT
-- Generate a RSA key that remains on the HSM by setting the "token" attribute equal to 1
EXEC sp_OAMethod @pubKeyAttr, 'UpdateBool', @success OUT, 'token', 1
-- Given that our key will reside on the token, we should give it two attributes (id and label) to help us
-- find it in future sessions.
-- First, we can give it an arbitrary ID. ID's are binary, so we specify bytes as either
-- "id_hex" for hexidecimal bytes,
-- "id_ascii" for the bytes of an ascii string,
-- "id" for bytes in base64 format.
DECLARE @keyId nvarchar(4000)
SELECT @keyId = '48656C6C6F'
EXEC sp_OAMethod @pubKeyAttr, 'UpdateString', @success OUT, 'id_hex', @keyId
-- We can also give our key a label with any descriptive string.
DECLARE @keyLabel nvarchar(4000)
SELECT @keyLabel = '2048-bit RSA key for testing'
EXEC sp_OAMethod @pubKeyAttr, 'UpdateString', @success OUT, 'label', @keyLabel
-- -----------------------------------------------------------------------------------
-- IMPORTANT: The ID for the public key must be the same as the ID for the private key.
-- -----------------------------------------------------------------------------------
-- Allow the public key to be used for encryption, signature verification, and symmetric key wrapping.
-- These attributes are optional.
EXEC sp_OAMethod @pubKeyAttr, 'UpdateBool', @success OUT, 'encrypt', 1
EXEC sp_OAMethod @pubKeyAttr, 'UpdateBool', @success OUT, 'verify', 1
EXEC sp_OAMethod @pubKeyAttr, 'UpdateBool', @success OUT, 'wrap', 1
-- Generate a 2048-bit RSA key.
-- This attribute is required.
EXEC sp_OAMethod @pubKeyAttr, 'UpdateInt', @success OUT, 'modulus_bits', 2048
DECLARE @privKeyAttr int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @privKeyAttr OUT
-- Generate a RSA key that remains on the HSM by setting the "token" attribute equal to 1
EXEC sp_OAMethod @privKeyAttr, 'UpdateBool', @success OUT, 'token', 1
-- Make sure we give the private key the same ID as the public key.
EXEC sp_OAMethod @privKeyAttr, 'UpdateString', @success OUT, 'id_hex', @keyId
-- We can also give our key a label with any descriptive string.
-- (Best to use the same label as for the public key)
EXEC sp_OAMethod @privKeyAttr, 'UpdateString', @success OUT, 'label', @keyLabel
-- Allow the private key to be used for signing and decryption.
EXEC sp_OAMethod @privKeyAttr, 'UpdateBool', @success OUT, 'sign', 1
EXEC sp_OAMethod @privKeyAttr, 'UpdateBool', @success OUT, 'decrypt', 1
-- Provide a JSON object to receive the public and private key handles.
DECLARE @jsonHandles int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonHandles OUT
EXEC sp_OASetProperty @jsonHandles, 'EmitCompact', 0
-- Provide a Chilkat public key object to receive the public key.
DECLARE @pubKey int
EXEC @hr = sp_OACreate 'Chilkat.PublicKey', @pubKey OUT
EXEC sp_OAMethod @pkcs11, 'GenRsaKey', @success OUT, @pubKeyAttr, @privKeyAttr, @jsonHandles, @pubKey
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @pkcs11, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed to generate an RSA key.'
END
ELSE
BEGIN
-- Sample JSON handles:
-- {
-- "public_key_handle": 18415630,
-- "private_key_handle": 74842125
-- }
EXEC sp_OAMethod @jsonHandles, 'Emit', @sTmp0 OUT
PRINT @sTmp0
EXEC sp_OAMethod @jsonHandles, 'UIntOf', @iTmp0 OUT, 'public_key_handle'
PRINT 'public_key_handle: ' + @iTmp0
EXEC sp_OAMethod @jsonHandles, 'UIntOf', @iTmp0 OUT, 'private_key_handle'
PRINT 'private_key_handle: ' + @iTmp0
PRINT 'public key JWK:'
EXEC sp_OAMethod @pubKey, 'GetJwk', @sTmp0 OUT
PRINT @sTmp0
-- Sample JWK:
-- {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
PRINT 'Success.'
END
EXEC sp_OAMethod @pkcs11, 'Logout', @success OUT
EXEC sp_OAMethod @pkcs11, 'CloseSession', @success OUT
EXEC @hr = sp_OADestroy @pkcs11
EXEC @hr = sp_OADestroy @pubKeyAttr
EXEC @hr = sp_OADestroy @privKeyAttr
EXEC @hr = sp_OADestroy @jsonHandles
EXEC @hr = sp_OADestroy @pubKey
END
GO