(Java) PKCS11 Import a Private Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing RSA private key onto the smartcard/token. The imported key is a token object, meaning it stays on the HSM and exists beyond the end 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;
        }

    // Let's import a certificate's private key onto the HSM.
    // First, we'll load the certificate from a .pfx (also known as .p12), which is a file format
    // that also includes the certificate's private key.
    CkCert cert = new CkCert();
    success = cert.LoadPfxFile("qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password");
    if (success == false) {
        System.out.println(cert.lastErrorText());
        return;
        }

    // Let's get the certificate's private key.
    CkPrivateKey privKey = cert.ExportPrivateKey();
    if (cert.get_LastMethodSuccess() == false) {
        System.out.println(cert.lastErrorText());
        return;
        }

    // Build a PKCS11 template to provide additional information about the key to be imported.
    CkJsonObject jsonTemplate = new CkJsonObject();

    // Indicate that the key is to be stored on the token.  It is NOT a session object.
    jsonTemplate.UpdateBool("token",true);

    // Indicate that the key can be used for signing.
    jsonTemplate.UpdateBool("sign",true);

    // Provide an arbitrary ID and label (anything you want).
    // The information in the ID and/or label provides one means for finding the key in future PKCS11 sessions.
    jsonTemplate.UpdateString("id_hex","010203040A0B0C0D0E0F");
    jsonTemplate.UpdateString("label","ehealth private key");

    // Import the key.  The private key handle is returned on success.  Otherwise 0 is returned.
    // If our only task for now is to simply import the key, we can ignore the returned handle, 
    // other than to check for success/failure.  Otherwise, the handle can be used in other PKCS11 operations.
    // This example just creates the key and does not use the returned handle.
    int keyHandle = pkcs11.ImportPrivateKey(privKey,jsonTemplate);
    if (keyHandle == 0) {
        System.out.println(pkcs11.lastErrorText());
        }
    else {
        System.out.println("key handle = " + keyHandle);
        System.out.println("Successfully imported a private key onto the HSM.");
        }

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