(Delphi DLL) PKCS11 Import a Private Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing RSA private key onto the smartcard/token. The imported key is a token object, meaning it stays on the HSM and exists beyond the end of the PKCS11 session.

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

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Pkcs11, Cert, JsonObject, PrivateKey;

...

procedure TForm1.Button1Click(Sender: TObject);
var
pkcs11: HCkPkcs11;
pin: PWideChar;
userType: Integer;
success: Boolean;
cert: HCkCert;
privKey: HCkPrivateKey;
jsonTemplate: HCkJsonObject;
keyHandle: Cardinal;

begin
// 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.

pkcs11 := CkPkcs11_Create();

// 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.
CkPkcs11_putSharedLibPath(pkcs11,'C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll');

// Establish a logged-on session.
pin := '0000';
userType := 1;
success := CkPkcs11_QuickSession(pkcs11,userType,pin);
if (success = False) then
  begin
    Memo1.Lines.Add(CkPkcs11__lastErrorText(pkcs11));
    Exit;
  end;

// Let's import a certificate's private key onto the HSM.
// First, we'll load the certificate from a .pfx (also known as .p12), which is a file format
// that also includes the certificate's private key.
cert := CkCert_Create();
success := CkCert_LoadPfxFile(cert,'qa_data/pfx/ehealth.fgov.be_testing.p12','p12_password');
if (success = False) then
  begin
    Memo1.Lines.Add(CkCert__lastErrorText(cert));
    Exit;
  end;

// Let's get the certificate's private key.
privKey := CkCert_ExportPrivateKey(cert);
if (CkCert_getLastMethodSuccess(cert) = False) then
  begin
    Memo1.Lines.Add(CkCert__lastErrorText(cert));
    Exit;
  end;

// Build a PKCS11 template to provide additional information about the key to be imported.
jsonTemplate := CkJsonObject_Create();

// Indicate that the key is to be stored on the token.  It is NOT a session object.
CkJsonObject_UpdateBool(jsonTemplate,'token',True);

// Indicate that the key can be used for signing.
CkJsonObject_UpdateBool(jsonTemplate,'sign',True);

// Provide an arbitrary ID and label (anything you want).
// The information in the ID and/or label provides one means for finding the key in future PKCS11 sessions.
CkJsonObject_UpdateString(jsonTemplate,'id_hex','010203040A0B0C0D0E0F');
CkJsonObject_UpdateString(jsonTemplate,'label','ehealth private key');

// Import the key.  The private key handle is returned on success.  Otherwise 0 is returned.
// If our only task for now is to simply import the key, we can ignore the returned handle, 
// other than to check for success/failure.  Otherwise, the handle can be used in other PKCS11 operations.
// This example just creates the key and does not use the returned handle.
keyHandle := CkPkcs11_ImportPrivateKey(pkcs11,privKey,jsonTemplate);
if (keyHandle = 0) then
  begin
    Memo1.Lines.Add(CkPkcs11__lastErrorText(pkcs11));
  end
else
  begin
    Memo1.Lines.Add('key handle = ' + IntToStr(keyHandle));
    Memo1.Lines.Add('Successfully imported a private key onto the HSM.');
  end;

CkPrivateKey_Dispose(privKey);

CkPkcs11_Logout(pkcs11);
CkPkcs11_CloseSession(pkcs11);

CkPkcs11_Dispose(pkcs11);
CkCert_Dispose(cert);
CkJsonObject_Dispose(jsonTemplate);

end;