Sample code for 30+ languages & platforms
Perl Requires Chilkat v9.5.0.96+

PKCS11 Generate Secret Key (such as AES)

See more PKCS11 Examples

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

Chilkat Perl Downloads

Chilkat2 Perl
use strict;
use warnings;
use Chilkat2;

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

my $pkcs11 = Chilkat2::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->SharedLibPath('C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll');

# Establish a logged-on session.
my $pin = '0000';
my $userType = 1;
my $success = $pkcs11->QuickSession($userType, $pin);
if (!$success) {
    print $pkcs11->LastErrorText, "\n";
    exit;
}

# 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.
my $keyType = 'AES';

# Specify attributes and abilities (how this key can be used) by providing a JSON template.
my $json = Chilkat2::JsonObject->new;

# The key can be extracted or wrapped.
$json->UpdateBool('extractable', 1);

# Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
$json->UpdateBool('encrypt', 1);
$json->UpdateBool('decrypt', 1);
$json->UpdateBool('wrap', 1);
$json->UpdateBool('unwrap', 1);

# 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);

my $keyHandle = $pkcs11->GenSecretKey($keyType, $json);
if ($keyHandle == 0) {
    print $pkcs11->LastErrorText, "\n";
    print "Failed to generate an AES key.\n";
} else {
    print 'key handle = ', $keyHandle, "\n";
    print "Success.\n";
}

$pkcs11->Logout();
$pkcs11->CloseSession();