Java

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.

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Pkcs11;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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.

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

        // Establish a logged-on session.
        String pin = "0000";
        int userType = 1;
        try {
            pkcs11.quickSession(userType, pin);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            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.
        JsonObject json = new 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);

        long keyHandle = pkcs11.genSecretKey(keyType, json);
        if (keyHandle == 0) {
            System.out.println(pkcs11.getLastErrorText());
            System.out.println("Failed to generate an AES key.");
        } else {
            System.out.println("key handle = " + keyHandle);
            System.out.println("Success.");
        }

        pkcs11.logout();
        pkcs11.closeSession();
    }
}