(Android™) Sign Manifest File to Generate a Passbook .pkpass file

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

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

    // Note: Requires Chilkat v9.5.0.75 or greater.

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

    // ---------------------------------------------------------------------------------------------
    // Note: Chilkat also has the capability to do everything in-memory (no files would be involved).  
    // See this example:  Sign Manifest File to Generate a Passbook .pkpass in Memory
    // ---------------------------------------------------------------------------------------------

    // First create the manifest.json
    boolean success;
    CkJsonObject manifest = new CkJsonObject();
    CkCrypt2 crypt = new CkCrypt2();

    CkZip zip = new CkZip();
    zip.NewZip("qa_data/p7s/pass-wallet/example.pkpass");
    // Set the AppendFromDir property to prevent that relative paths from being stored in the .pkpass archive.
    zip.put_AppendFromDir("qa_data/p7s/pass-wallet/");

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

    String fileHash;
    String filePath;
    filePath = "qa_data/p7s/pass-wallet/icon.png";
    fileHash = crypt.hashFileENC(filePath);
    zip.AppendOneFileOrDir("icon.png",false);
    manifest.UpdateString("\"icon.png\"",fileHash);

    filePath = "qa_data/p7s/pass-wallet/icon@2x.png";
    fileHash = crypt.hashFileENC(filePath);
    zip.AppendOneFileOrDir("icon@2x.png",false);
    manifest.UpdateString("\"icon@2x.png\"",fileHash);

    filePath = "qa_data/p7s/pass-wallet/logo.png";
    fileHash = crypt.hashFileENC(filePath);
    zip.AppendOneFileOrDir("logo.png",false);
    manifest.UpdateString("\"logo.png\"",fileHash);

    filePath = "qa_data/p7s/pass-wallet/logo@2x.png";
    fileHash = crypt.hashFileENC(filePath);
    zip.AppendOneFileOrDir("logo@2x.png",false);
    manifest.UpdateString("\"logo@2x.png\"",fileHash);

    filePath = "qa_data/p7s/pass-wallet/pass.json";
    fileHash = crypt.hashFileENC(filePath);
    zip.AppendOneFileOrDir("pass.json",false);
    manifest.UpdateString("\"pass.json\"",fileHash);

    CkStringBuilder sbJson = new CkStringBuilder();
    manifest.EmitSb(sbJson);
    String manifestPath = "qa_data/p7s/pass-wallet/manifest.json";
    sbJson.WriteFile(manifestPath,"utf-8",false);
    zip.AppendOneFileOrDir("manifest.json",false);

    // 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 != true) {
            Log.i(TAG, appleWwdrCert.lastErrorText());
            return;
            }

        }

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

    // Use a digital certificate and private key from a PFX file (.pfx or .p12).
    String pfxPath = "qa_data/pfx/cert_test123.pfx";
    String pfxPassword = "test123";

    CkCert cert = new CkCert();
    success = cert.LoadPfxFile(pfxPath,pfxPassword);
    if (success != true) {
        Log.i(TAG, cert.lastErrorText());
        return;
        }

    // Provide the signing cert (with associated private key).
    success = crypt.SetSigningCert(cert);
    if (success != true) {
        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 file to produce a file named "signature".
    String sigPath = "qa_data/p7s/pass-wallet/signature";

    // Create the "signature" file.
    success = crypt.CreateP7S(manifestPath,sigPath);
    if (success == false) {
        Log.i(TAG, crypt.lastErrorText());
        return;
        }

    zip.AppendOneFileOrDir("signature",false);

    // ---------------------------------------------------------------------------------------------
    // 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).
    success = zip.WriteZipAndClose();
    if (success != true) {
        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."
  }
}