gala 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 282d6469414bc3815ece41d1ca0c88df2943c081
+  data.tar.gz: 1952197de23562117ce28641a8379c311190fbf3
+SHA512:
+  metadata.gz: 8718b796da3467a4fea07e223a872f4a52daaab38241a0cd3cede1672653c18bc8577e6297f72d45aa65a22fcce064e0a7bc07fdadfd64c68087b82c8a927d27
+  data.tar.gz: a43e76f47d3d81c988221a5cd52a1cbb259cd9781860029984b5686df66948b3f39a00d7b3887eba5c0c4b931dfb6c0b1add7ae29ac472915518fa09751af4bb

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+pkg/
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+gemspec
+
+gem 'aead', git: 'https://github.com/Shopify/aead.git', ref: '340e7718d8bd9c1fcf3c443e32f439436ea2b70d'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GIT
+  remote: https://github.com/Shopify/aead.git
+  revision: 340e7718d8bd9c1fcf3c443e32f439436ea2b70d
+  ref: 340e7718d8bd9c1fcf3c443e32f439436ea2b70d
+  specs:
+    aead (1.8.2)
+      macaddr (~> 1)
+
+PATH
+  remote: .
+  specs:
+    gala (0.3.1)
+      aead (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    macaddr (1.7.1)
+      systemu (~> 2.6.2)
+    rake (12.0.0)
+    systemu (2.6.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aead!
+  bundler (~> 1.14)
+  gala!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   1.14.6

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2016] [Spreedly, Inc.]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Gala
+
+Named after the [Gala apple](http://en.wikipedia.org/wiki/Gala_(apple)), Gala is a Ruby library for decrypting [Apple Pay payment tokens](https://developer.apple.com/library/ios/documentation/PassKit/Reference/PaymentTokenJSON/PaymentTokenJSON.html).
+
+Gala is available under the MIT License.
+
+## Install
+
+Add to your `Gemfile`:
+
+```ruby
+gem "gala", "~> 0.3.1"
+```
+
+Or, if you need to track a development branch:
+
+```ruby
+gem "gala", git: "https://github.com/spreedly/gala.git", ref: master
+```
+
+Then `bundle install` to fetch Gala into your local environment.
+
+## Usage
+
+Gala works by:
+
+1. Initializing an instance of `Gala::PaymentToken` with the hash of values present in the Apple Pay token string (a JSON representation of [this data](https://developer.apple.com/library/ios/documentation/PassKit/Reference/PaymentTokenJSON/PaymentTokenJSON.html)).
+2. Decrypting the token using the PEM formatted merchant certificate and private key (the latter of which, at least, is managed by a third-party such as a gateway or independent processor like [Spreedly](https://spreedly.com)).
+
+```ruby
+require "gala"
+
+# token_json = raw token string you get from your iOS app
+token_attrs = JSON.parse(token_json)
+token = Gala::PaymentToken.new(token_attrs)
+
+certificate_pem = File.read("mycert.pem")
+private_key_pem = File.read("private_key.pem")
+
+decrypted_json = token.decrypt(certificate_pem, private_key_pem)
+JSON.parse(decrypted_json)
+# =>
+{
+  "applicationPrimaryAccountNumber"=>"4109370251004320",
+  "applicationExpirationDate"=>"200731",
+  "currencyCode"=>"840",
+  "transactionAmount"=>100,
+  "deviceManufacturerIdentifier"=>"040010030273",
+  "paymentDataType"=>"3DSecure",
+  "paymentData"=> {
+    "onlinePaymentCryptogram"=>"Af9x/QwAA/DjmU65oyc1MAABAAA=",
+    "eciIndicator"=>"5"
+  }
+}
+```
+
+## Testing
+
+```session
+$ rake test
+Started
+......
+
+Finished in 0.017918 seconds.
+```
+
+## Releasing
+
+To cut a new gem:
+
+### Setup RubyGems account
+
+Make sure you have a [RubyGems account](https://rubygems.org) and have setup your local gem credentials with something like this:
+
+```bash
+$ curl -u rwdaigle https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+<enter rubygems account password>
+```
+
+If you are not yet listed as a gem owner, you will need to [request access](http://guides.rubygems.org/command-reference/#gem-owner) from @rwdaigle.
+
+### Release
+
+Build and release the gem with (all changes should be committed and pushed to Github):
+
+```bash
+$ rake release
+```
+
+## Changelog
+
+### v0.3.1
+
+* Use Shopify aead library for compatibility w/ Ruby >= v2.2
+
+### v0.3.0
+
+* Verify payment token signature
+
+## Contributors
+
+* [dankimio](https://github.com/dankimio)
+* [davidsantoso](https://github.com/davidsantoso)
+* [mrezentes](https://github.com/mrezentes)
+* [jnormore](https://github.com/jnormore)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/gala.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gala/version'
+
+Gem::Specification.new do |spec|
+  spec.name              = "gala"
+  spec.version           = Gala::VERSION
+  spec.authors           = ["Mark Bennett", "Ryan Daigle"]
+  spec.email             = ["ryan@spreedly.com"]
+
+  spec.summary           = "Apple Pay payment token decryption library"
+  spec.description       = "Given an (encrypted) Apple Pay token, verify and decrypt it"
+  spec.homepage          = "https://github.com/spreedly/gala"
+  spec.license           = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.8.7"
+
+  spec.add_runtime_dependency 'aead', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+end

data/lib/gala.rb

@@ -0,0 +1 @@
+require_relative "gala/payment_token"

data/lib/gala/payment_token.rb

@@ -0,0 +1,122 @@
+require 'openssl'
+require 'base64'
+require 'aead'
+
+module Gala
+  class PaymentToken
+
+    MERCHANT_ID_FIELD_OID = "1.2.840.113635.100.6.32"
+    LEAF_CERTIFICATE_OID = "1.2.840.113635.100.6.29"
+    INTERMEDIATE_CERTIFICATE_OID = "1.2.840.113635.100.6.2.14"
+    APPLE_ROOT_CERT = File.read(File.dirname(__FILE__) + "/resources/AppleRootCA-G3.pem")
+
+    attr_accessor :version, :data, :signature, :transaction_id, :ephemeral_public_key,
+      :public_key_hash, :application_data
+
+    class MissingMerchantIdError < StandardError; end;
+    class InvalidSignatureError < StandardError; end;
+
+    def initialize(token_attrs)
+      self.version = token_attrs["version"]
+      self.data = token_attrs["data"]
+      self.signature = token_attrs["signature"]
+      headers = token_attrs["header"]
+      self.transaction_id = headers["transactionId"]
+      self.ephemeral_public_key = headers["ephemeralPublicKey"]
+      self.public_key_hash = headers["publicKeyHash"]
+      self.application_data = headers["applicationData"]
+    end
+
+    def decrypt(certificate_pem, private_key_pem)
+      self.class.validate_signature(signature, ephemeral_public_key, data, transaction_id, application_data)
+
+      certificate = OpenSSL::X509::Certificate.new(certificate_pem)
+      merchant_id = self.class.extract_merchant_id(certificate)
+      private_key = OpenSSL::PKey::EC.new(private_key_pem)
+      shared_secret = self.class.generate_shared_secret(private_key, ephemeral_public_key)
+      symmetric_key = self.class.generate_symmetric_key(merchant_id, shared_secret)
+
+      # Return JSON string, up to caller to parse
+      self.class.decrypt(Base64.decode64(data), symmetric_key)
+    end
+
+    class << self
+
+      def validate_signature(signature, ephemeral_public_key, data, transaction_id, application_data)
+        # Ensure that the certificates contain the correct custom OIDs
+        intermediate_cert = nil
+        leaf_cert = nil
+        p7 = OpenSSL::PKCS7.new(Base64.decode64(signature))
+        p7.certificates.each {|c|
+          c.extensions.each { |e|
+            leaf_cert = c if e.oid == LEAF_CERTIFICATE_OID
+            intermediate_cert = c if e.oid == INTERMEDIATE_CERTIFICATE_OID
+          }
+        }
+        raise InvalidSignatureError, "Signature does not contain the correct custom OIDs." unless leaf_cert && intermediate_cert
+
+        # Ensure that the root CA is the Apple Root CA - G3
+        root_cert = certificate = OpenSSL::X509::Certificate.new(APPLE_ROOT_CERT)
+
+        # Ensure that there is a valid X.509 chain of trust from the signature to the root CA
+        raise InvalidSignatureError, "Unable to verify a valid chain of trust from signature to root certificate." unless chain_of_trust_verified?(leaf_cert, intermediate_cert, root_cert)
+
+        #Ensure that the signature is a valid ECDSA signature
+        unless application_data
+          verification_string = Base64.decode64(ephemeral_public_key) + Base64.decode64(data) + [transaction_id].pack("H*")
+          # verification_string = verification_string + application_data.pack("H*") if application_data
+          store = OpenSSL::X509::Store.new
+          verified = p7.verify([], store, verification_string, OpenSSL::PKCS7::NOVERIFY )
+          raise InvalidSignatureError, "The given signature is not a valid ECDSA signature." unless verified
+        end
+      end
+
+      def chain_of_trust_verified?(leaf_cert, intermediate_cert, root_cert)
+        trusted_certificate_store = OpenSSL::X509::Store.new.tap do |store|
+          store.add_cert(root_cert)
+          store.add_cert(intermediate_cert)
+        end
+        trusted_certificate_store.verify(leaf_cert)
+      end
+
+      def extract_merchant_id(certificate)
+        merchant_id_field = certificate.extensions.find do |ext|
+          ext.oid == MERCHANT_ID_FIELD_OID
+        end
+        raise MissingMerchantIdError unless merchant_id_field
+        val = merchant_id_field.value
+        val[2..(val.length - 1)]
+      end
+
+      def generate_shared_secret(private_key, ephemeral_public_key)
+        public_ec = OpenSSL::PKey::EC.new(Base64.decode64(ephemeral_public_key))
+        point = OpenSSL::PKey::EC::Point.new(private_key.group, public_ec.public_key.to_bn)
+        private_key.dh_compute_key(point)
+      end
+
+      # Derive the symmetric key using the key derivation function described in NIST SP 800-56A, section 5.8.1
+      #   http://csrc.nist.gov/publications/nistpubs/800-56A/SP800-56A_Revision1_Mar08-2007.pdf
+      def generate_symmetric_key(merchant_id, shared_secret)
+
+        kdf_algorithm = "\x0D" + 'id-aes256-GCM'
+        kdf_party_v = merchant_id.scan(/../).inject("") { |binary,hn| binary << hn.to_i(16).chr } # Converts each pair of hex characters into bytes in a string.
+        kdf_info = kdf_algorithm + "Apple" + kdf_party_v
+
+        digest = Digest::SHA256.new
+        digest << 0.chr * 3
+        digest << 1.chr
+        digest << shared_secret
+        digest << kdf_info
+        digest.digest
+      end
+
+      def decrypt(encrypted_data, symmetric_key)
+        init_length = 16
+        init_vector = 0.chr * init_length
+        mode = ::AEAD::Cipher.new('aes-256-gcm')
+        cipher = mode.new(symmetric_key, iv_len: init_length)
+        cipher.decrypt(init_vector, '', encrypted_data)
+      end
+    end
+  end
+end

data/lib/gala/resources/AppleRootCA-G3.pem

@@ -0,0 +1,15 @@
+-----BEGIN CERTIFICATE-----
+MIICQzCCAcmgAwIBAgIILcX8iNLFS5UwCgYIKoZIzj0EAwMwZzEbMBkGA1UEAwwS
+QXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9u
+IEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcN
+MTQwNDMwMTgxOTA2WhcNMzkwNDMwMTgxOTA2WjBnMRswGQYDVQQDDBJBcHBsZSBS
+b290IENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9y
+aXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzB2MBAGByqGSM49
+AgEGBSuBBAAiA2IABJjpLz1AcqTtkyJygRMc3RCV8cWjTnHcFBbZDuWmBSp3ZHtf
+TjjTuxxEtX/1H7YyYl3J6YRbTzBPEVoA/VhYDKX1DyxNB0cTddqXl5dvMVztK517
+IDvYuVTZXpmkOlEKMaNCMEAwHQYDVR0OBBYEFLuw3qFYM4iapIqZ3r6966/ayySr
+MA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMAoGCCqGSM49BAMDA2gA
+MGUCMQCD6cHEFl4aXTQY2e3v9GwOAEZLuN+yRhHFD/3meoyhpmvOwgPUnPWTxnS4
+at+qIxUCMG1mihDK1A3UT82NQz60imOlM27jbdoXt2QfyFMm+YhidDkLF1vLUagM
+6BgD56KyKA==
+-----END CERTIFICATE-----

data/lib/gala/version.rb

@@ -0,0 +1,3 @@
+module Gala
+  VERSION = "0.3.1" unless defined? Gala::VERSION
+end

data/notes.md

@@ -0,0 +1,18 @@
+## Generating the Apple Root Certificate
+
+In order to get the certificate into a usable format, the following java code was used.
+```
+  InputStream inputStream = null;
+  X509Certificate appleRootCertificate = null;
+
+  try {
+    InputStream in = new FileInputStream(new File("/Users/mrezentes/Documents/workspace/AndroidPay/src/AppleRootCA-G3.cer"));
+    CertificateFactory certificateFactory = CertificateFactory.getInstance(X_509);
+    appleRootCertificate = (X509Certificate) certificateFactory.generateCertificate(in);
+    PEMWriter pw = new PEMWriter(new PrintWriter(System.out));
+    pw.writeObject(appleRootCertificate);
+    pw.flush();
+    pw.close();
+  }
+
+```

data/test/fixtures/certificate.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCBBagAwIBAgIIUyrEM4IzBHQwCgYIKoZIzj0EAwIwgYAxNDAyBgNVBAMM
+K0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0gRzIxJjAk
+BgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApB
+cHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDEwMjYxMjEwMTBaFw0xNjExMjQx
+MjEwMTBaMIGhMS4wLAYKCZImiZPyLGQBAQwebWVyY2hhbnQuY29tLnNlYXRnZWVr
+LlNlYXRHZWVrMTQwMgYDVQQDDCtNZXJjaGFudCBJRDogbWVyY2hhbnQuY29tLnNl
+YXRnZWVrLlNlYXRHZWVrMRMwEQYDVQQLDAo5QjNRWTlXQlo1MRcwFQYDVQQKDA5T
+ZWF0R2VlaywgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMB
+BwNCAAQPjiA1kTEodST2wy5d5kQFrM0D5qBX9Ukry8W6D+vC7OqbMoTm/upRM1GR
+HeA2LaVTrwAnpGhoO0ETqYF2Nu4Vo4ICVTCCAlEwRwYIKwYBBQUHAQEEOzA5MDcG
+CCsGAQUFBzABhitodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxld3dk
+cmNhMjAxMB0GA1UdDgQWBBQWGfKgPgVBX8JOv84q1c04HShMmzAMBgNVHRMBAf8E
+AjAAMB8GA1UdIwQYMBaAFIS2hMw6hmJyFlmU6BqjvUjfOt8LMIIBHQYDVR0gBIIB
+FDCCARAwggEMBgkqhkiG92NkBQEwgf4wgcMGCCsGAQUFBwICMIG2DIGzUmVsaWFu
+Y2Ugb24gdGhpcyBjZXJ0aWZpY2F0ZSBieSBhbnkgcGFydHkgYXNzdW1lcyBhY2Nl
+cHRhbmNlIG9mIHRoZSB0aGVuIGFwcGxpY2FibGUgc3RhbmRhcmQgdGVybXMgYW5k
+IGNvbmRpdGlvbnMgb2YgdXNlLCBjZXJ0aWZpY2F0ZSBwb2xpY3kgYW5kIGNlcnRp
+ZmljYXRpb24gcHJhY3RpY2Ugc3RhdGVtZW50cy4wNgYIKwYBBQUHAgEWKmh0dHA6
+Ly93d3cuYXBwbGUuY29tL2NlcnRpZmljYXRlYXV0aG9yaXR5LzA2BgNVHR8ELzAt
+MCugKaAnhiVodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXd3ZHJjYTIuY3JsMA4G
+A1UdDwEB/wQEAwIDKDBPBgkqhkiG92NkBiAEQgxARjkzOEY0NjU4Q0EyQzFDOUMz
+OEI4REZDQjVEQkIyQTIyNDU2MDdEREUyRjExNDYyMEU4NDY4RUY1MkQyMDhDQTAK
+BggqhkjOPQQDAgNIADBFAiB+Q4zzpMj2DJTCIhDFBcmwK1zQAC70fY2IsYd8+Nxu
+uwIhAKj9RrTOyiaQnoT5Mqi3UHopb6xTugl3LUDBloraBHyP
+-----END CERTIFICATE-----

data/test/fixtures/private_key.pem

@@ -0,0 +1,5 @@
+-----BEGIN EC PRIVATE KEY-----
+MHcCAQEEIDqrpF0KEFW4Ncb76vyBi3StFLiT222sFC0wC3LsP1M9oAoGCCqGSM49
+AwEHoUQDQgAED44gNZExKHUk9sMuXeZEBazNA+agV/VJK8vFug/rwuzqmzKE5v7q
+UTNRkR3gNi2lU68AJ6RoaDtBE6mBdjbuFQ==
+-----END EC PRIVATE KEY-----

data/test/fixtures/token.json

@@ -0,0 +1,10 @@
+{
+  "version":"EC_v1",
+  "data":"4OZho15e9Yp5K0EtKergKzeRpPAjnKHwmSNnagxhjwhKQ5d29sfTXjdbh1CtTJ4DYjsD6kfulNUnYmBTsruphBz7RRVI1WI8P0LrmfTnImjcq1mi+BRN7EtR2y6MkDmAr78anff91hlc+x8eWD/NpO/oZ1ey5qV5RBy/Jp5zh6ndVUVq8MHHhvQv4pLy5Tfi57Yo4RUhAsyXyTh4x/p1360BZmoWomK15NcJfUmoUCuwEYoi7xUkRwNr1z4MKnzMfneSRpUgdc0wADMeB6u1jcuwqQnnh2cusiagOTCfD6jO6tmouvu6KO54uU7bAbKz6cocIOEAOc6keyFXG5dfw8i3hJg6G2vIefHCwcKu1zFCHr4P7jLnYFDEhvxLm1KskDcuZeQHAkBMmLRSgj9NIcpBa94VN/JTga8W75IWAA==",
+  "signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID4jCCA4igAwIBAgIIJEPyqAad9XcwCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDkyNTIyMDYxMVoXDTE5MDkyNDIyMDYxMVowXzElMCMGA1UEAwwcZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtUFJPRDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhV37evWx7Ihj2jdcJChIY3HsL1vLCg9hGCV2Ur0pUEbg0IO2BHzQH6DMx8cVMP36zIg1rrV1O/0komJPnwPE6OCAhEwggINMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDEwHQYDVR0OBBYEFJRX22/VdIGGiYl2L35XhQfnm1gkMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMA4GA1UdDwEB/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0gAMEUCIHKKnw+Soyq5mXQr1V62c0BXKpaHodYu9TWXEPUWPpbpAiEAkTecfW6+W5l0r0ADfzTCPq2YtbS39w01XIayqBNy8bEwggLuMIICdaADAgECAghJbS+/OpjalzAKBggqhkjOPQQDAjBnMRswGQYDVQQDDBJBcHBsZSBSb290IENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDA1MDYyMzQ2MzBaFw0yOTA1MDYyMzQ2MzBaMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABPAXEYQZ12SF1RpeJYEHduiAou/ee65N4I38S5PhM1bVZls1riLQl3YNIk57ugj9dhfOiMt2u2ZwvsjoKYT/VEWjgfcwgfQwRgYIKwYBBQUHAQEEOjA4MDYGCCsGAQUFBzABhipodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlcm9vdGNhZzMwHQYDVR0OBBYEFCPyScRPk+TvJ+bE9ihsP6K7/S5LMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUu7DeoVgziJqkipnevr3rr9rLJKswNwYDVR0fBDAwLjAsoCqgKIYmaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVyb290Y2FnMy5jcmwwDgYDVR0PAQH/BAQDAgEGMBAGCiqGSIb3Y2QGAg4EAgUAMAoGCCqGSM49BAMCA2cAMGQCMDrPcoNRFpmxhvs1w1bKYr/0F+3ZD3VNoo6+8ZyBXkK3ifiY95tZn5jVQQ2PnenC/gIwMi3VRCGwowV3bF3zODuQZ/0XfCwhbZZPxnJpghJvVPh6fRuZy5sJiSFhBpkPCZIdAAAxggFfMIIBWwIBATCBhjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMCCCRD8qgGnfV3MA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTQxMDI3MTk1MTQzWjAvBgkqhkiG9w0BCQQxIgQge01fe4e1+woRnaV3o8bZL7vmTLEDsnZfTQq+D7GYjnIwCgYIKoZIzj0EAwIERzBFAiEA5090eyrUE7pjWb8MqUeDp/vEY98vtrT0Uvre/66ccqQCICYe6cen516x/xsfi/tJr3SbTdxO25ZdN1bPH0Jiqgw7AAAAAAAA",
+  "header":{
+    "transactionId":"2686f5297f123ec7fd9d31074d43d201953ca75f098890375f13aed2737d92f2",
+    "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEMwliotf2ICjiMwREdqyHSilqZzuV2fZey86nBIDlTY8sNMJv9CPpL5/DKg4bIEMe6qaj67mz4LWdr7Er0Ld5qA==",
+    "publicKeyHash":"LbsUwAT6w1JV9tFXocU813TCHks+LSuFF0R/eBkrWnQ="
+  }
+}

data/test/payment_token_test.rb

@@ -0,0 +1,62 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'test/unit'
+require 'json'
+require 'gala'
+
+class Gala::PaymentTokenTest < Test::Unit::TestCase
+
+  def setup
+    fixtures = File.dirname(__FILE__) + "/fixtures/"
+    @token_attrs = JSON.parse(File.read(fixtures + "token.json"))
+    @certificate = File.read(fixtures + "certificate.pem")
+    @private_key = File.read(fixtures + "private_key.pem")
+    @payment_token = Gala::PaymentToken.new(@token_attrs)
+    @merchant_id = "F938F4658CA2C1C9C38B8DFCB5DBB2A2245607DDE2F114620E8468EF52D208CA"
+    @shared_secret = Base64.decode64("a2pPfemSdA560FnzLSv8zfdlWdGJTonApOLq1zfgx8w=")
+    @symmetric_key = Base64.decode64("HOSago9Z1DhhukQvzmgpuCGPuwq1W0AgasMQWNZvUIY=")
+  end
+
+  def test_initialize
+    assert_equal @token_attrs["version"], @payment_token.version
+    assert_equal @token_attrs["data"], @payment_token.data
+    assert_equal @token_attrs["signature"], @payment_token.signature
+    assert_equal @token_attrs["header"]["transactionId"], @payment_token.transaction_id
+    assert_equal @token_attrs["header"]["ephemeralPublicKey"], @payment_token.ephemeral_public_key
+    assert_equal @token_attrs["header"]["publicKeyHash"], @payment_token.public_key_hash
+  end
+
+  def test_merchant_id
+    cert = OpenSSL::X509::Certificate.new(@certificate)
+    assert_equal @merchant_id, Gala::PaymentToken.extract_merchant_id(cert)
+  end
+
+  def test_shared_secret
+    priv_key = OpenSSL::PKey::EC.new(@private_key)
+    assert_equal @shared_secret, Gala::PaymentToken.generate_shared_secret(priv_key, @token_attrs["header"]["ephemeralPublicKey"])
+  end
+
+  def test_symmetric_key
+    assert_equal @symmetric_key, Gala::PaymentToken.generate_symmetric_key(@merchant_id, @shared_secret)
+  end
+
+  def test_decrypt
+    payment_data = JSON.parse(@payment_token.decrypt(@certificate, @private_key))
+    assert_equal "4109370251004320", payment_data["applicationPrimaryAccountNumber"]
+    assert_equal "200731", payment_data["applicationExpirationDate"]
+    assert_equal "840", payment_data["currencyCode"]
+    assert_equal 100, payment_data["transactionAmount"]
+    assert_equal nil, payment_data["cardholderName"]
+    assert_equal "040010030273", payment_data["deviceManufacturerIdentifier"]
+    assert_equal "3DSecure", payment_data["paymentDataType"]
+    assert_equal "Af9x/QwAA/DjmU65oyc1MAABAAA=", payment_data["paymentData"]["onlinePaymentCryptogram"]
+    assert_equal "5", payment_data["paymentData"]["eciIndicator"]
+  end
+
+  def test_failed_decrypt
+    @payment_token.data = "bogus4OZho15e9Yp5K0EtKergKzeRpPAjnKHwmSNnagxhjwhKQ5d29sfTXjdbh1CtTJ4DYjsD6kfulNUnYmBTsruphBz7RRVI1WI8P0LrmfTnImjcq1mi"
+    exception = assert_raise Gala::PaymentToken::InvalidSignatureError do
+      JSON.parse(@payment_token.decrypt(@certificate, @private_key))
+    end
+    assert_equal("The given signature is not a valid ECDSA signature.", exception.message)
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: gala
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Mark Bennett
+- Ryan Daigle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aead
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Given an (encrypted) Apple Pay token, verify and decrypt it
+email:
+- ryan@spreedly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gala.gemspec
+- lib/gala.rb
+- lib/gala/payment_token.rb
+- lib/gala/resources/AppleRootCA-G3.pem
+- lib/gala/version.rb
+- notes.md
+- test/fixtures/certificate.pem
+- test/fixtures/private_key.pem
+- test/fixtures/token.json
+- test/payment_token_test.rb
+homepage: https://github.com/spreedly/gala
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Apple Pay payment token decryption library
+test_files:
+- test/fixtures/certificate.pem
+- test/fixtures/private_key.pem
+- test/fixtures/token.json
+- test/payment_token_test.rb