firebase_token_auth 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5305379d0a25319f82d126005ab06fa001e3acd812f73bc737c21af4789fe3b4
-  data.tar.gz: 9b9ed78c1d0e8387e917c29fc16af5fc30f7e13942ddead22cb7ef47e7402080
+  metadata.gz: 458419a9cc0f07b5c6d11037ef5a932cee6918b8f0d656dea8a16c57d42ff7bf
+  data.tar.gz: 5b8c715921349dfa20f5c5b8129c324edd75af04c4461360a01e1a918ba9a857
 SHA512:
-  metadata.gz: 33dae3ad79c87a10d2afd84886d50ae492be46ee442940e82c51273c63b1b02a95d3f5ab221ca85de8a5792df902a660c8fb3dfa09da51d868180fa8280d4468
-  data.tar.gz: 3b48e3429138938178a62622d1b3c36333920e4c872781a4de7e6d7108084ccc3029003edfbea0ddefec77fbfdc08a091caa0523ab941a9c94ffccf07b283925
+  metadata.gz: 8dbc7ccb903400b3c5606ccbfdb0668e7efba7debe2b0320655d621d67cd45f5ddd941e429071bdc6f5df2d27e85ad1fbedbdcd3841e4dd5a67367c530580b2c
+  data.tar.gz: 0771c7af336de27b1559398d7cb356fd5922e8847524be8c6aef2b478b92b6c6d68419446127e4b856d7365cd785d7110e754a9d5ca4f135a9f68b80b9f67fe4

data/.github/workflows/test.yml

@@ -1,6 +1,8 @@
 name: rspec
 
-on: push
+on:
+  workflow_dispatch:
+  push:
 
 jobs:
   rspec:

data/README.md

@@ -91,6 +91,26 @@ puts c_token
 # => "eyJhbGciOXXX.eyJpc3MiOiJmaXJlYmFzXXXX.v7y7LoBXXXXX" # dummy
 ```
 
+### verify custom token
+```ruby
+require 'firebase_token_auth'
+
+FirebaseTokenAuth.configure do |config|
+  config.project_id = 'your_project_id'
+  config.json_key_io = "#{Rails.root}/path/to/service_account_credentials.json"
+end
+
+client = FirebaseTokenAuth.build
+result = client.verify_custom_token(custom_token)
+
+puts result
+# => {:expires_in=>3600,
+#   :id_token=>"<id_token>",
+#   :is_new_user=>"<true/false>",
+#   :kind=>"identitytoolkit#VerifyCustomTokenResponse",
+#   :refresh_token=>"<refresh_token>"}
+```
+
 ### fetch users info from firebase
 ```ruby
 require 'firebase_token_auth'

data/lib/firebase_token_auth/admin_client.rb

@@ -20,6 +20,15 @@ module FirebaseTokenAuth
       service.set_account_info(request)
     end
 
+    def verify_custom_token(custom_token)
+      request = Google::Apis::IdentitytoolkitV3::VerifyCustomTokenRequest.new(
+        token: custom_token,
+        return_secure_token: true
+      )
+
+      service.verify_custom_token(request)
+    end
+
     private
 
       def permit_attributes(attr_hash)

data/lib/firebase_token_auth/client.rb

@@ -47,10 +47,14 @@ module FirebaseTokenAuth
                   iat: now_seconds,
                   exp: now_seconds + (60 * 60),
                   uid: uid }
-      payload.merge!({ claim: additional_claims }) if additional_claims
+      payload.merge!({ claims: additional_claims }) if additional_claims
       JWT.encode(payload, configuration.private_key, ALGORITHM)
     end
 
+    def verify_custom_token(custom_token)
+      admin_client.verify_custom_token(custom_token).to_h
+    end
+
     def user_search_by_email(email)
       admin_client.get_account_info({ email: [email] })&.users&.map(&:to_h)
     end

data/lib/firebase_token_auth/configuration.rb

@@ -29,7 +29,7 @@ module FirebaseTokenAuth
 
       @auth = if json_key_io
                 io = json_key_io.respond_to?(:read) ? json_key_io : File.open(json_key_io)
-                io.rewind if io.respond_to?(:read) 
+                io.rewind if io.respond_to?(:read)
                 Google::Auth::ServiceAccountCredentials.make_creds(
                   json_key_io: io,
                   scope: scope
@@ -41,7 +41,7 @@ module FirebaseTokenAuth
 
       if json_key_io
         json_io = json_key_io.respond_to?(:read) ? json_key_io : File.open(json_key_io)
-        json_io.rewind if json_key_io.respond_to?(:read) 
+        json_io.rewind if json_key_io.respond_to?(:read)
         parsed = JSON.parse(json_io.read)
         @private_key = OpenSSL::PKey::RSA.new(parsed['private_key'])
         @client_email = parsed['client_email']

data/lib/firebase_token_auth/validator.rb

@@ -14,11 +14,16 @@ module FirebaseTokenAuth
       raise ValidationError, 'Firebase ID token has no "sub" (subject) claim.' unless payload['sub'].is_a?(String)
       raise ValidationError, 'Firebase ID token has an empty string "sub" (subject) claim.' if payload['sub'].empty?
       raise ValidationError, 'Firebase ID token has "sub" (subject) claim longer than 128 characters.' if payload['sub'].size > 128
+      raise ValidationError, 'Firebase ID token has expired.' if expired?(payload['exp'])
     end
 
     def extract_kid(id_token)
       decoded = JWT.decode(id_token, nil, false, algorithm: ALGORITHM)
       [decoded[1]['kid'], decoded]
     end
+
+    def expired?(exp)
+      exp.to_i <= Time.now.to_i
+    end
   end
 end

data/lib/firebase_token_auth/version.rb

@@ -1,3 +1,3 @@
 module FirebaseTokenAuth
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase_token_auth
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - miyataka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-identitytoolkit_v3