(Objective-C) 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.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoPkcs11.h>
#import <NSString.h>
#import <CkoStringBuilder.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;
}

// Generate a 256-bit AES key.
// (32 bytes is 256 bits)
// Append 32 bytes of random data in the base64 encoding.
CkoStringBuilder *sbAesKey = [[CkoStringBuilder alloc] init];
[sbAesKey AppendRandom: [NSNumber numberWithInt: 32] encoding: @"base64"];

CkoJsonObject *attrs = [[CkoJsonObject alloc] init];
// Specify the type of object, and the type of key.
[attrs UpdateString: @"class" value: @"CKO_SECRET_KEY"];
[attrs UpdateString: @"key_type" value: @"CKK_AES"];
// Add an optional label if desired.
[attrs UpdateString: @"label" value: @"My AES wrapping/unwrapping key"];
// Allow the key to be use for wrapping and unwrapping operations.
[attrs UpdateBool: @"wrap" value: YES];
[attrs UpdateBool: @"unwrap" value: YES];

// Provide the AES key material.
[attrs UpdateString: @"value" value: [sbAesKey GetAsString]];

// 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.
unsigned long objHandle = [pkcs11 CreatePkcs11Object: attrs];
if (objHandle == 0) {
    NSLog(@"%@",pkcs11.LastErrorText);
    NSLog(@"%@",@"Failed.");
}
else {
    NSLog(@"%@%d",@"PKCS11 object handle = ",objHandle);
    NSLog(@"%@",@"Successfully created a 256-bit AES session key.");
}

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

[pkcs11 Logout];
[pkcs11 CloseSession];