(Java) PKCS11 Generate a Session EC Key on the HSM

See more PKCS11 Examples

Generates an EC key on the smart card or token and returns the public and private key handles. The generated EC key exists only for the duration of the PKCS11 session.

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

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

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

    CkPkcs11 pkcs11 = new CkPkcs11();

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

    // Establish a logged-on session.
    String pin = "0000";
    int userType = 1;
    boolean success = pkcs11.QuickSession(userType,pin);
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        return;
        }

    // 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.
    CkJsonObject pubKeyAttr = new CkJsonObject();

    // Allow the public key to be used for signature verification
    pubKeyAttr.UpdateBool("verify",true);

    // Specify the kind of EC key to generate by the curve name
    // Possible curve names are:
    // secp256r1  (also known as P-256 and prime256v1)
    // secp384r1  (also known as P-384)
    // secp521r1  (also known as P-521)
    // secp256k1 (This is the curve used for Bitcoin)
    // secp192r1
    // secp224r1
    // brainpoolP160r1
    // brainpoolP192r1
    // brainpoolP192r1
    // brainpoolP224r1
    // brainpoolP256r1
    // brainpoolP320r1
    // brainpoolP384r1
    // brainpoolP512r1
    // Note: Your smart card or token might not support all of the above EC curves (assuming it supports EC at all).

    // This attribute is required.
    pubKeyAttr.UpdateString("ec_params","secp256r1");

    CkJsonObject privKeyAttr = new CkJsonObject();

    // Generate a session EC key.
    // A session key exists only for the duration of the PKS11 session.
    // To generate an EC key that resides on the HSM, set the "token" attribute equal to true
    privKeyAttr.UpdateBool("token",false);

    // Allow the private key to be used for signing.
    privKeyAttr.UpdateBool("sign",true);

    // Provide a JSON object to receive the public and private key handles.
    CkJsonObject jsonHandles = new CkJsonObject();
    jsonHandles.put_EmitCompact(false);

    // Provide a Chilkat public key object to receive the public key.
    CkPublicKey pubKey = new CkPublicKey();

    success = pkcs11.GenEcKey(pubKeyAttr,privKeyAttr,jsonHandles,pubKey);
    if (success == false) {
        System.out.println(pkcs11.lastErrorText());
        System.out.println("Failed to generate an EC key.");
        }
    else {
        // Sample JSON handles:
        // {
        //   "public_key_handle": 18415630,
        //   "private_key_handle": 74842125
        // }
        System.out.println(jsonHandles.emit());
        System.out.println("public_key_handle: " + jsonHandles.UIntOf("public_key_handle"));
        System.out.println("private_key_handle: " + jsonHandles.UIntOf("private_key_handle"));
        System.out.println("public key JWK:");
        System.out.println(pubKey.getJwk());
        // Sample JWK:
        // {"kty":"EC","crv":"P-256","x":"EDy-Sxl0DZ8tvzy_qnIYl6DYPFjTVnyJ2I9ZTCfKds4","y":"yBZ4HK2yF7F7ZEOn59CgTQp2ApQJ8ZOF736yZxY6LOE"}
        System.out.println("Success.");
        }

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