(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 .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Chilkat.Pkcs11 pkcs11 = new Chilkat.Pkcs11();

// 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.
string pin = "0000";
int userType = 1;
bool success = pkcs11.QuickSession(userType,pin);
if (success == false) {
    Debug.WriteLine(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.
string keyType = "AES";

// Specify attributes and abilities (how this key can be used) by providing a JSON template.
Chilkat.JsonObject json = new Chilkat.JsonObject();

// The key can be extracted or wrapped.
json.UpdateBool("extractable",true);

// Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
json.UpdateBool("encrypt",true);
json.UpdateBool("decrypt",true);
json.UpdateBool("wrap",true);
json.UpdateBool("unwrap",true);

// 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",32);

uint keyHandle = pkcs11.GenSecretKey(keyType,json);
if (keyHandle == 0) {
    Debug.WriteLine(pkcs11.LastErrorText);
    Debug.WriteLine("Failed to generate an AES key.");
}
else {
    Debug.WriteLine("key handle = " + Convert.ToString(keyHandle));
    Debug.WriteLine("Success.");
}

pkcs11.Logout();
pkcs11.CloseSession();