Rust

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.

Rust

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

let pkcs11 = chilkat::Pkcs11::new();

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

// Establish a logged-on session.
let pin = "0000".to_string();
let user_type = 1;
if pkcs11.quick_session(user_type, &pin).is_err() {
    println!("{}", pkcs11.last_error_text());
    return;
}

// Generate a 256-bit AES key.
// (32 bytes is 256 bits)
// Append 32 bytes of random data in the base64 encoding.
let sb_aes_key = chilkat::StringBuilder::new();
let _ = sb_aes_key.append_random(32, "base64");

let attrs = chilkat::JsonObject::new();
// Specify the type of object, and the type of key.
let _ = attrs.update_string("class", "CKO_SECRET_KEY");
let _ = attrs.update_string("key_type", "CKK_AES");
// Add an optional label if desired.
let _ = attrs.update_string("label", "My AES wrapping/unwrapping key");
// Allow the key to be use for wrapping and unwrapping operations.
let _ = attrs.update_bool("wrap", true);
let _ = attrs.update_bool("unwrap", true);

// Provide the AES key material.
let _ = attrs.update_string("value", &sb_aes_key.get_as_string().unwrap_or_default());

// 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.
let obj_handle = pkcs11.create_pkcs11_object(&attrs);
if obj_handle == 0 {
    println!("{}", pkcs11.last_error_text());
    println!("Failed.");
} else {
    println!("PKCS11 object handle = {}", obj_handle);
    println!("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.
// ...
// ...

let _ = pkcs11.logout();
let _ = pkcs11.close_session();