(Android™) PKCS11 Certificate Chain

See more PKCS11 Examples

Demonstrates how to make CA certs available for the certificate chain to be included when creating a signature (using a PKCS11 compatible smart card / USB token) such as for PDF, XMLDSig, etc.

Note: This example requires Chilkat v9.5.0.88 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();

    // You will use the DLL (or shared lib) provided by your smart card vendor, or a DLL compatible with your smart card.
    // On Windows, if the DLL is located in C:\Windows\System32, specify only the filename.
    // Otherwise provide the full path.
    pkcs11.put_SharedLibPath("bit4xpki.dll");

    boolean success = pkcs11.Initialize();
    if (success == false) {
        Log.i(TAG, pkcs11.lastErrorText());
        return;
        }

    // Pass -1 for the slotID to open a session on the first non-empty slot.
    int slotID = -1;

    // Open a session.
    boolean readWrite = true;
    success = pkcs11.OpenSession(slotID,readWrite);
    if (success == false) {
        Log.i(TAG, pkcs11.lastErrorText());
        return;
        }

    // Make it an authenticated session by calling Login.
    int userType = 1;
    // Make sure to use the correct PIN for your smart card..
    String pin = "0000";
    success = pkcs11.Login(userType,pin);
    if (success == false) {
        Log.i(TAG, pkcs11.lastErrorText());
        success = pkcs11.CloseSession();
        return;
        }

    // Get the certificate (on the smart card) that has a private key.
    CkCert cert = new CkCert();
    success = pkcs11.FindCert("privateKey","",cert);
    if (success == true) {
        Log.i(TAG, "Cert with private key: " + cert.subjectCN());
        }
    else {
        Log.i(TAG, "No certificates having a private key were found.");
        success = pkcs11.CloseSession();
        return;
        }

    // If the certificates in the chain of authentication were contained on the smart card,
    // then Chilkat would already have them (via the FindCert function) and the certs in the chain will be automatically used
    // as needed when signing occurs.

    // If you have CA certs located elsewhere, such as in .cer files, you can make them available to Chilkat in the following way:

    CkXmlCertVault certVault = new CkXmlCertVault();
    // Please review the methods available in the XML certificate vault class.  Different methods exist for adding certificates
    // from various sources, such as PEM, PFX, or in-memory sources..
    success = certVault.AddCertFile("someDir/caIntermediateCert.cer");
    // ...
    success = certVault.AddCertFile("someDir/caCert.cer");
    // (Your code should check the return value to make sure it succeeded.)

    success = cert.UseCertVault(certVault);
    if (success == false) {
        Log.i(TAG, cert.lastErrorText());
        success = pkcs11.CloseSession();
        return;
        }

    // --------------------------------------------------------------------------
    // At this point, we have the cert (and certs in the chain of authentication) to be used for signing.
    // The code for using the certificate in creating the digital signature, such as for a PDF, XML, etc., go here...

    // --------------------------------------------------------------------------

    // Revert to an unauthenticated session by calling Logout.
    success = pkcs11.Logout();
    if (success == false) {
        Log.i(TAG, pkcs11.lastErrorText());
        success = pkcs11.CloseSession();
        return;
        }

    // When finished, close the session.
    // It is important to close the session (memory leaks will occur if the session is not properly closed).
    success = pkcs11.CloseSession();
    if (success == false) {
        Log.i(TAG, pkcs11.lastErrorText());
        return;
        }

    Log.i(TAG, "Success.");

  }

  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."
  }
}