Android™

Sign Manifest File to Generate a Passbook .pkpass in Memory

Demonstrates how to create a Passbook .pkpass archive by creating a signature of a manifest file and then zipping to a .pkpass archive in memory Android™

// 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);

    boolean success = false;

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // ---------------------------------------------------------------------------------------------
    // This example is the same as Sign Manifest File to Generate a Passbook .pkpass file
    // except everything happens in memory (no input files, no output files)
    // ---------------------------------------------------------------------------------------------

    // First create the manifest.json

    CkJsonObject manifest = new CkJsonObject();
    CkCrypt2 crypt = new CkCrypt2();

    CkZip zip = new CkZip();
    zip.NewZip("notUsedAndNeverCreated.zip");

    crypt.put_HashAlgorithm("sha1");
    // Return hashes as lowercase hex.
    crypt.put_EncodingMode("hexlower");

    String digestStr;

    CkBinData pngData = new CkBinData();
    // Assume we load the pngData with bytes for "icon.png" from somewhere, such as a byte array in memory.
    zip.AddBd("icon.png",pngData);
    digestStr = crypt.hashBdENC(pngData);
    manifest.UpdateString("\"icon.png\"",digestStr);

    pngData.Clear();
    // Assume we load the pngData with bytes for "icon@2x.png" from somewhere...
    zip.AddBd("icon@2x.png",pngData);
    digestStr = crypt.hashBdENC(pngData);
    manifest.UpdateString("\"icon@2x.png\"",digestStr);

    pngData.Clear();
    // Assume we load the pngData with bytes for "logo.png" from somewhere...
    zip.AddBd("logo.png",pngData);
    digestStr = crypt.hashBdENC(pngData);
    manifest.UpdateString("\"logo.png\"",digestStr);

    pngData.Clear();
    // Assume we load the pngData with bytes for "logo@2x.png" from somewhere...
    zip.AddBd("logo@2x.png",pngData);
    digestStr = crypt.hashBdENC(pngData);
    manifest.UpdateString("\"logo@2x.png\"",digestStr);

    String passJson = "{ .... }";    //  Contains the contents of pass.json
    zip.AddString("pass.json",passJson,"utf-8");
    digestStr = crypt.hashStringENC(passJson);
    manifest.UpdateString("\"pass.json\"",digestStr);

    zip.AddString("manifest.json",manifest.emit(),"utf-8");

    // Make sure we have the Apple WWDR intermediate certificate available for 
    // the cert chain in the signature.
    CkXmlCertVault certVault = new CkXmlCertVault();
    CkCert appleWwdrCert = new CkCert();
    success = appleWwdrCert.LoadByCommonName("Apple Worldwide Developer Relations Certification Authority");
    if (success != true) {
        Log.i(TAG, "The Apple WWDR intermediate certificate is not installed.");
        Log.i(TAG, "It is available at https://developer.apple.com/certificationauthority/AppleWWDRCA.cer");
        Log.i(TAG, "You may alternatively load the .cer like this...");
        success = appleWwdrCert.LoadFromFile("qa_data/certs/AppleWWDRCA.cer");
        if (success == false) {
            Log.i(TAG, appleWwdrCert.lastErrorText());
            return;
            }

        }

    certVault.AddCert(appleWwdrCert);
    crypt.UseCertVault(certVault);

    // Use a digital certificate and private key from a PFX
    CkBinData bdPfx = new CkBinData();
    // Assume we loaded a PFX into bdPfx....
    String pfxPassword = "test123";

    CkCert cert = new CkCert();
    success = cert.LoadPfxBd(bdPfx,pfxPassword);
    if (success == false) {
        Log.i(TAG, cert.lastErrorText());
        return;
        }

    // Provide the signing cert (with associated private key).
    success = crypt.SetSigningCert(cert);
    if (success == false) {
        Log.i(TAG, crypt.lastErrorText());
        return;
        }

    // Specify the signed attributes to be included.
    // (These attributes appear to not be necessary, but we're including
    // them just in case they become necessary in the future.)
    CkJsonObject jsonSignedAttrs = new CkJsonObject();
    jsonSignedAttrs.UpdateInt("contentType",1);
    jsonSignedAttrs.UpdateInt("signingTime",1);
    crypt.put_SigningAttributes(jsonSignedAttrs.emit());

    // Sign the manifest JSON to produce a signature
    crypt.put_EncodingMode("base64");
    String sig = crypt.signStringENC(manifest.emit());
    CkBinData bdSig = new CkBinData();
    bdSig.AppendEncoded(sig,"base64");
    zip.AddBd("signature",bdSig);

    // ---------------------------------------------------------------------------------------------
    // Note: Chilkat also has the capability to do everything in-memory (no files would be involved).  
    // If this is of interest, please send email to support@chilkatsoft.com
    // ---------------------------------------------------------------------------------------------

    // Create the .pkipass archive (which is a .zip archive containing the required files).
    // the .zip is written to bdZip
    CkBinData bdZip = new CkBinData();
    success = zip.WriteBd(bdZip);
    if (success == false) {
        Log.i(TAG, zip.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."
  }
}