(PHP ActiveX) PKCS11 Generate a Session RSA Key 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 exists only for the duration of the PKCS11 session.

Note: This example requires Chilkat v9.5.0.96 or later.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Pkcs11')
$pkcs11 = new COM("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.
$pin = '0000';
$userType = 1;
$success = $pkcs11->QuickSession($userType,$pin);
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    exit;
}

// 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.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$pubKeyAttr = new COM("Chilkat.JsonObject");

// Allow the public key to be used for encryption, signature verification, and symmetric key wrapping
// These attributes are optional.
$pubKeyAttr->UpdateBool('encrypt',1);
$pubKeyAttr->UpdateBool('verify',1);
$pubKeyAttr->UpdateBool('wrap',1);

// Generate a 2048-bit RSA key.
// This attribute is required.
$pubKeyAttr->UpdateInt('modulus_bits',2048);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$privKeyAttr = new COM("Chilkat.JsonObject");

// Generate a session RSA key.
// A session key exists only for the duration of the PKS11 session.
// To generate an RSA key that resides on the HSM, set the "token" attribute equal to 1
$privKeyAttr->UpdateBool('token',0);

// Allow the private key to be used for signing and decryption.
$privKeyAttr->UpdateBool('sign',1);
$privKeyAttr->UpdateBool('decrypt',1);

// Do not allow the private key to be extracted.
$privKeyAttr->UpdateBool('extractable',0);

// Provide a JSON object to receive the public and private key handles.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonHandles = new COM("Chilkat.JsonObject");
$jsonHandles->EmitCompact = 0;

// Provide a Chilkat public key object to receive the public key.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.PublicKey')
$pubKey = new COM("Chilkat.PublicKey");

$success = $pkcs11->GenRsaKey($pubKeyAttr,$privKeyAttr,$jsonHandles,$pubKey);
if ($success == 0) {
    print $pkcs11->LastErrorText . "\n";
    print 'Failed to generate an RSA key.' . "\n";
}
else {
    // Sample JSON handles:
    // {
    //   "public_key_handle": 18415630,
    //   "private_key_handle": 74842125
    // }
    print $jsonHandles->emit() . "\n";
    print 'public_key_handle: ' . $jsonHandles->UIntOf('public_key_handle') . "\n";
    print 'private_key_handle: ' . $jsonHandles->UIntOf('private_key_handle') . "\n";
    print 'public key JWK:' . "\n";
    print $pubKey->getJwk() . "\n";
    // Sample JWK:
    // {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
    print 'Success.' . "\n";
}

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

?>