(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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 = Chilkat::CkJsonObject.new()
crypt = Chilkat::CkCrypt2.new()

zip = Chilkat::CkZip.new()
zip.NewZip("notUsedAndNeverCreated.zip")

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

pngData = Chilkat::CkBinData.new()
# 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 = Chilkat::CkXmlCertVault.new()
appleWwdrCert = Chilkat::CkCert.new()
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
    end

end

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

# Use a digital certificate and private key from a PFX
bdPfx = Chilkat::CkBinData.new()
# Assume we loaded a PFX into bdPfx....
pfxPassword = "test123"

cert = Chilkat::CkCert.new()
success = cert.LoadPfxBd(bdPfx,pfxPassword)
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

# Provide the signing cert (with associated private key).
success = crypt.SetSigningCert(cert)
if (success != true)
    print crypt.lastErrorText() + "\n";
    exit
end

# 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 = Chilkat::CkJsonObject.new()
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 = Chilkat::CkBinData.new()
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 = Chilkat::CkBinData.new()
success = zip.WriteBd(bdZip)
if (success != true)
    print zip.lastErrorText() + "\n";
    exit
end

print "Success." + "\n";