apple_id 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a849c5014ce8f45fc143ad955ef8ce22ff7639955dcce14ce58812cfa0e0a523
-  data.tar.gz: 1b5dfa5e7179bf7102887e48f9870d510648fb6a5dbf246b15ba6ae7a0f8f76d
+  metadata.gz: 4447d024e910da0480e07d58164eefce5daa78c1389ecb8a571ad20bf969c291
+  data.tar.gz: 9ad9be586a2c3e96e7fc3d35eb07c2c6360cde0736b705c7584bdd0fc5a6aac1
 SHA512:
-  metadata.gz: 220695160a1be005b4cfbd1e4e214966ab5b5fd7af1c9819eef95339a81fe2af2482ee9e30b595991c093bbd51505135d343b28ab2c74138abce3f9e311ca2ef
-  data.tar.gz: 10bed7c9835616114fa2ac2929a515ba4fe30c2552c589ca2a15c207bfe57547cdc775dc543cae91dc20e6b04641240e50e303dc590f47ba67a6e255bab57913
+  metadata.gz: c8655e9f56f4ba8e4e71b5048be8d637bb9e798acd48a5cccd979f6f55ef1d73cb1b7a2cf9e84c46a6d95727b8cf749f5b4e4a8bc7fe7a28170acea05e7581e5
+  data.tar.gz: a097b0398ac8da49da3874a6c073abbe844339773b638761a6f33a204c9c0207a72fdab38d2eb10cf5c0edddddb4562dfd7189ad8b2e7bc8d5dfec9064903eeb

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

data/lib/apple_id/event_token/event.rb

@@ -0,0 +1,11 @@
+module AppleID
+  class EventToken::Event < OpenIDConnect::ConnectObject
+    attr_required :type, :sub, :event_time
+
+    class << self
+      def decode(json_string)
+        new JSON.parse(json_string).with_indifferent_access
+      end
+    end
+  end
+end

data/lib/apple_id/event_token.rb

@@ -0,0 +1,61 @@
+module AppleID
+  class EventToken < OpenIDConnect::ConnectObject
+    class VerificationFailed < Error; end
+
+    # NOTE: Apple uses `events` for the JWT key, but this gem uses `event` since it's always a single JSON Object.
+    #       Once they start returning an array of events, this gem might use `events` as the attribute name.
+    attr_required :iss, :aud, :exp, :iat, :jti, :event
+    alias_method :original_jwt, :raw_attributes
+
+    def initialize(attributes = {})
+      super
+      @event = Event.decode attributes[:events]
+    end
+
+    def verify!(verify_signature: true, client: nil)
+      verify_signature! if verify_signature
+      verify_claims! client, nonce, state, access_token, code
+      self
+    end
+
+    class << self
+      def decode(jwt_string)
+        new JSON::JWT.decode jwt_string, :skip_verification
+      end
+    end
+
+    private
+
+    def verify_signature!
+      original_jwt.verify! JWKS.fetch(original_jwt.kid)
+    rescue
+      raise VerificationFailed, 'Signature Verification Failed'
+    end
+
+    def verify_claims!(client, nonce, state, access_token, code)
+      aud = if client.respond_to?(:identifier)
+        client.identifier
+      else
+        client
+      end
+
+      failure_reasons = []
+      if self.iss != ISSUER
+        failure_reasons << :iss
+      end
+      if aud.present? && self.aud != aud
+        failure_reasons << :aud
+      end
+      if Time.now.to_i < iat
+        failure_reasons << :iat
+      end
+      if Time.now.to_i >= exp
+        failure_reasons << :exp
+      end
+
+      if failure_reasons.present?
+        raise VerificationFailed, "Claims Verification Failed at #{failure_reasons}"
+      end
+    end
+  end
+end

data/lib/apple_id/id_token.rb

@@ -1,6 +1,6 @@
 module AppleID
   class IdToken < OpenIDConnect::ResponseObject::IdToken
-    class VerificationFailed < StandardError; end
+    class VerificationFailed < Error; end
 
     attr_optional :email, :email_verified, :is_private_email, :nonce_supported, :real_user_status
     attr_accessor :original_jwt_string

data/lib/apple_id.rb

@@ -8,6 +8,8 @@ module AppleID
     ::File.join(::File.dirname(__FILE__), '../VERSION')
   ).chomp
 
+  class Error < StandardError; end
+
   def self.logger
     @@logger
   end
@@ -56,4 +58,6 @@ require 'apple_id/access_token'
 require 'apple_id/id_token'
 require 'apple_id/id_token/real_user_status'
 require 'apple_id/jwks'
+require 'apple_id/event_token'
+require 'apple_id/event_token/event'
 require 'apple_id/api/user_migration'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apple_id
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - nov
@@ -146,6 +146,8 @@ files:
 - lib/apple_id/access_token.rb
 - lib/apple_id/api/user_migration.rb
 - lib/apple_id/client.rb
+- lib/apple_id/event_token.rb
+- lib/apple_id/event_token/event.rb
 - lib/apple_id/id_token.rb
 - lib/apple_id/id_token/real_user_status.rb
 - lib/apple_id/jwks.rb