(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoPkcs11.h>
#import <NSString.h>
#import <CkoCert.h>
#import <CkoPrivateKey.h>
#import <CkoJsonObject.h>

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

CkoPkcs11 *pkcs11 = [[CkoPkcs11 alloc] init];

// 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.
pkcs11.SharedLibPath = @"C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll";

// Establish a logged-on session.
NSString *pin = @"0000";
int userType = 1;
BOOL success = [pkcs11 QuickSession: [NSNumber numberWithInt: userType] pin: pin];
if (success == NO) {
    NSLog(@"%@",pkcs11.LastErrorText);
    return;
}

// 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.
CkoCert *cert = [[CkoCert alloc] init];
success = [cert LoadPfxFile: @"qa_data/pfx/ehealth.fgov.be_testing.p12" password: @"p12_password"];
if (success == NO) {
    NSLog(@"%@",cert.LastErrorText);
    return;
}

// Let's get the certificate's private key.
CkoPrivateKey *privKey = [cert ExportPrivateKey];
if (cert.LastMethodSuccess == NO) {
    NSLog(@"%@",cert.LastErrorText);
    return;
}

// Build a PKCS11 template to provide additional information about the key to be imported.
CkoJsonObject *jsonTemplate = [[CkoJsonObject alloc] init];

// Indicate that the key is to be stored on the token.  It is NOT a session object.
[jsonTemplate UpdateBool: @"token" value: YES];

// Indicate that the key can be used for signing.
[jsonTemplate UpdateBool: @"sign" value: YES];

// 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.
[jsonTemplate UpdateString: @"id_hex" value: @"010203040A0B0C0D0E0F"];
[jsonTemplate UpdateString: @"label" value: @"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.
unsigned long keyHandle = [pkcs11 ImportPrivateKey: privKey jsonTemplate: jsonTemplate];
if (keyHandle == 0) {
    NSLog(@"%@",pkcs11.LastErrorText);
}
else {
    NSLog(@"%@%d",@"key handle = ",keyHandle);
    NSLog(@"%@",@"Successfully imported a private key onto the HSM.");
}

[pkcs11 Logout];
[pkcs11 CloseSession];