(PHP Extension) 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

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

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

$zip = new CkZip();
$zip->NewZip('notUsedAndNeverCreated.zip');

$crypt->put_HashAlgorithm('sha1');
// Return hashes as lowercase hex.
$crypt->put_EncodingMode('hexlower');

$pngData = new CkBinData();
// Assume we load the pngData with bytes for "icon.png" from somewhere, such as a byte array in memory.
// entry is a CkZipEntry
$entry = $zip->AppendBd('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...
// entry is a CkZipEntry
$entry = $zip->AppendBd('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...
// entry is a CkZipEntry
$entry = $zip->AppendBd('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...
// entry is a CkZipEntry
$entry = $zip->AppendBd('logo@2x.png',$pngData);

$digestStr = $crypt->hashBdENC($pngData);
$manifest->UpdateString('\'logo@2x.png\'',$digestStr);

$passJson = '{ .... }';//  Contains the contents of pass.json
// entry is a CkZipEntry
$entry = $zip->AppendString('pass.json',$passJson);

$digestStr = $crypt->hashStringENC($passJson);
$manifest->UpdateString('\'pass.json\'',$digestStr);

// entry is a CkZipEntry
$entry = $zip->AppendString('manifest.json',$manifest->emit());

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

}

$certVault->AddCert($appleWwdrCert);
$crypt->UseCertVault($certVault);

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

$cert = new CkCert();
$success = $cert->LoadPfxBd($bdPfx,$pfxPassword);
if ($success != true) {
    print $cert->lastErrorText() . "\n";
    exit;
}

// Provide the signing cert (with associated private key).
$success = $crypt->SetSigningCert($cert);
if ($success != true) {
    print $crypt->lastErrorText() . "\n";
    exit;
}

// 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.)
$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');
$sig = $crypt->signStringENC($manifest->emit());
$bdSig = new CkBinData();
$bdSig->AppendEncoded($sig,'base64');
// entry is a CkZipEntry
$entry = $zip->AppendBd('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
$bdZip = new CkBinData();
$success = $zip->WriteBd($bdZip);
if ($success != true) {
    print $zip->lastErrorText() . "\n";
    exit;
}

print 'Success.' . "\n";

?>