(Objective-C) PKCS11 Generate a RSA Key that stays on the HSM

See more PKCS11 Examples

Generates an RSA key on the smart card or token and returns the public and private key handles. The generated RSA key stays on the HSM even after the PKCS11 session has ended.

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>
#import <CkoPublicKey.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.
// Use your actual PIN here.
NSString *pin = @"0000";
int userType = 1;
BOOL success = [pkcs11 QuickSession: [NSNumber numberWithInt: userType] pin: pin];
if (success == NO) {
    NSLog(@"%@",pkcs11.LastErrorText);
    return;
}

// Specify attributes and abilities (how this key can be used) by providing a JSON template.
// One template is for the public key, and the other for the private key.
CkoJsonObject *pubKeyAttr = [[CkoJsonObject alloc] init];

// Generate a RSA key that remains on the HSM by setting the "token" attribute equal to YES
[pubKeyAttr UpdateBool: @"token" value: YES];

// Given that our key will reside on the token, we should give it two attributes (id and label) to help us
// find it in future sessions.

// First, we can give it an arbitrary ID.  ID's are binary, so we specify bytes as either 
// "id_hex" for hexidecimal bytes, 
// "id_ascii" for the bytes of an ascii string, 
// "id" for bytes in base64 format.
NSString *keyId = @"48656C6C6F";
[pubKeyAttr UpdateString: @"id_hex" value: keyId];

// We can also give our key a label with any descriptive string.
NSString *keyLabel = @"2048-bit RSA key for testing";
[pubKeyAttr UpdateString: @"label" value: keyLabel];

// -----------------------------------------------------------------------------------
// IMPORTANT: The ID for the public key must be the same as the ID for the private key.
// -----------------------------------------------------------------------------------

// Allow the public key to be used for encryption, signature verification, and symmetric key wrapping.
// These attributes are optional.
[pubKeyAttr UpdateBool: @"encrypt" value: YES];
[pubKeyAttr UpdateBool: @"verify" value: YES];
[pubKeyAttr UpdateBool: @"wrap" value: YES];

// Generate a 2048-bit RSA key.
// This attribute is required.
[pubKeyAttr UpdateInt: @"modulus_bits" value: [NSNumber numberWithInt: 2048]];

CkoJsonObject *privKeyAttr = [[CkoJsonObject alloc] init];

// Generate a RSA key that remains on the HSM by setting the "token" attribute equal to YES
[privKeyAttr UpdateBool: @"token" value: YES];

// Make sure we give the private key the same ID as the public key.
[privKeyAttr UpdateString: @"id_hex" value: keyId];

// We can also give our key a label with any descriptive string.
// (Best to use the same label as for the public key)
[privKeyAttr UpdateString: @"label" value: keyLabel];

// Allow the private key to be used for signing and decryption.
[privKeyAttr UpdateBool: @"sign" value: YES];
[privKeyAttr UpdateBool: @"decrypt" value: YES];

// Do not allow the private key to be extracted.
[privKeyAttr UpdateBool: @"extractable" value: NO];

// Provide a JSON object to receive the public and private key handles.
CkoJsonObject *jsonHandles = [[CkoJsonObject alloc] init];
jsonHandles.EmitCompact = NO;

// Provide a Chilkat public key object to receive the public key.
CkoPublicKey *pubKey = [[CkoPublicKey alloc] init];

success = [pkcs11 GenRsaKey: pubKeyAttr privateAttrs: privKeyAttr jsonOut: jsonHandles pubKey: pubKey];
if (success == NO) {
    NSLog(@"%@",pkcs11.LastErrorText);
    NSLog(@"%@",@"Failed to generate an RSA key.");
}
else {
    // Sample JSON handles:
    // {
    //   "public_key_handle": 18415630,
    //   "private_key_handle": 74842125
    // }
    NSLog(@"%@",[jsonHandles Emit]);
    NSLog(@"%@%d",@"public_key_handle: ",[jsonHandles UIntOf: @"public_key_handle"]);
    NSLog(@"%@%d",@"private_key_handle: ",[jsonHandles UIntOf: @"private_key_handle"]);
    NSLog(@"%@",@"public key JWK:");
    NSLog(@"%@",[pubKey GetJwk]);
    // Sample JWK:
    // {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
    NSLog(@"%@",@"Success.");
}

[pkcs11 Logout];
[pkcs11 CloseSession];