Delphi DLL

PKCS11 Import an Existing AES Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing AES symmetric encrytion key onto the smartcard/token. The imported AES key is a session object, and only exists for the duration of the PKCS11 session. (AES keys are typically used for wrapping/unwrapping RSA and EC keys.)

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

Delphi DLL

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
pkcs11: HCkPkcs11;
pin: PWideChar;
userType: Integer;
sbAesKey: HCkStringBuilder;
attrs: HCkJsonObject;
objHandle: Cardinal;

begin
success := False;

// 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;

// Generate a 256-bit AES key.
// (32 bytes is 256 bits)
// Append 32 bytes of random data in the base64 encoding.
sbAesKey := CkStringBuilder_Create();
CkStringBuilder_AppendRandom(sbAesKey,32,'base64');

attrs := CkJsonObject_Create();
// Specify the type of object, and the type of key.
CkJsonObject_UpdateString(attrs,'class','CKO_SECRET_KEY');
CkJsonObject_UpdateString(attrs,'key_type','CKK_AES');
// Add an optional label if desired.
CkJsonObject_UpdateString(attrs,'label','My AES wrapping/unwrapping key');
// Allow the key to be use for wrapping and unwrapping operations.
CkJsonObject_UpdateBool(attrs,'wrap',True);
CkJsonObject_UpdateBool(attrs,'unwrap',True);

// Provide the AES key material.
CkJsonObject_UpdateString(attrs,'value',CkStringBuilder__getAsString(sbAesKey));

// Create the object (i.e. create the AES key with the given key material.)
// Returns the PKCS11 object handle of the created AES session key.
objHandle := CkPkcs11_CreatePkcs11Object(pkcs11,attrs);
if (objHandle = 0) then
  begin
    Memo1.Lines.Add(CkPkcs11__lastErrorText(pkcs11));
    Memo1.Lines.Add('Failed.');
  end
else
  begin
    Memo1.Lines.Add('PKCS11 object handle = ' + IntToStr(objHandle));
    Memo1.Lines.Add('Successfully created a 256-bit AES session key.');
  end;

// Typically, you would do other things in the PKCS11 session that use the handle of AES key we just created.
// ...
// ...

CkPkcs11_Logout(pkcs11);
CkPkcs11_CloseSession(pkcs11);

CkPkcs11_Dispose(pkcs11);
CkStringBuilder_Dispose(sbAesKey);
CkJsonObject_Dispose(attrs);

end;