(Objective-C) PKCS11 Generate Secret Key (such as AES)

See more PKCS11 Examples

Generates a symmetric secret key such as AES on the HSM.

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 <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 generate a 256-bit AES key on the token, which will exist for the duration of this session.
// Symmetric keys, such as AES keys, are typically created (or imported) and used during a single session.

// Other possible values for keyType are "AES XTS", "Blowfish", "Twofish", "ChaCha20", and others. 
// In virtually all cases, you'll want to create an AES key.
NSString *keyType = @"AES";

// Specify attributes and abilities (how this key can be used) by providing a JSON template.
CkoJsonObject *json = [[CkoJsonObject alloc] init];

// The key can be extracted or wrapped.
[json UpdateBool: @"extractable" value: YES];

// Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
[json UpdateBool: @"encrypt" value: YES];
[json UpdateBool: @"decrypt" value: YES];
[json UpdateBool: @"wrap" value: YES];
[json UpdateBool: @"unwrap" value: YES];

// Indicate a 256-bit AES key is to be generated by setting the value_len attribute equal to the key size in bytes.
// (32 bytes * 8 bits/byte = 256 bits)
[json UpdateInt: @"value_len" value: [NSNumber numberWithInt: 32]];

unsigned long keyHandle = [pkcs11 GenSecretKey: keyType jsonTemplate: json];
if (keyHandle == 0) {
    NSLog(@"%@",pkcs11.LastErrorText);
    NSLog(@"%@",@"Failed to generate an AES key.");
}
else {
    NSLog(@"%@%d",@"key handle = ",keyHandle);
    NSLog(@"%@",@"Success.");
}

[pkcs11 Logout];
[pkcs11 CloseSession];