(Android™) 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 Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // 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) {
        Log.i(TAG, 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 encryption, signature verification, and symmetric key wrapping
    // These attributes are optional.
    pubKeyAttr.UpdateBool("encrypt",true);
    pubKeyAttr.UpdateBool("verify",true);
    pubKeyAttr.UpdateBool("wrap",true);

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

    CkJsonObject privKeyAttr = new CkJsonObject();

    // 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 true
    privKeyAttr.UpdateBool("token",false);

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

    // Do not allow the private key to be extracted.
    privKeyAttr.UpdateBool("extractable",false);

    // 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.GenRsaKey(pubKeyAttr,privKeyAttr,jsonHandles,pubKey);
    if (success == false) {
        Log.i(TAG, pkcs11.lastErrorText());
        Log.i(TAG, "Failed to generate an RSA key.");
        }
    else {
        // Sample JSON handles:
        // {
        //   "public_key_handle": 18415630,
        //   "private_key_handle": 74842125
        // }
        Log.i(TAG, jsonHandles.emit());
        Log.i(TAG, "public_key_handle: " + String.valueOf(jsonHandles.UIntOf("public_key_handle")));
        Log.i(TAG, "private_key_handle: " + String.valueOf(jsonHandles.UIntOf("private_key_handle")));
        Log.i(TAG, "public key JWK:");
        Log.i(TAG, pubKey.getJwk());
        // Sample JWK:
        // {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
        Log.i(TAG, "Success.");
        }

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

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}