firebase_id_token 3.0.0 → 4.0.0

data/spec/firebase_id_token/signature_spec.rb

@@ -8,7 +8,8 @@ module FirebaseIdToken
     let(:mock_certificates) do
       allow(Certificates)
         .to(receive(:find))
-        .with(an_instance_of(String), raise_error: raise_certificates_error)
+        .with(an_instance_of(String), raise_error: raise_certificates_error,
+          source: :id_token)
         .and_return(OpenSSL::X509::Certificate.new(jwt['certificate']))
     end
 
@@ -31,6 +32,19 @@ module FirebaseIdToken
       it 'returns nil with a invalid key format' do
         expect(described_class.verify('aaa')).to be(nil)
       end
+
+      it 'returns nil when the token has no sub claim' do
+        payload = {
+          'iss' => 'https://securetoken.google.com/firebase-id-token',
+          'aud' => 'firebase-id-token',
+          'exp' => Time.now.to_i + 3600,
+          'iat' => Time.now.to_i - 60
+        }
+        token = JWT.encode(payload,
+          OpenSSL::PKey::RSA.new(jwt['private_key']), 'RS256', kid: 'test')
+
+        expect(described_class.verify(token)).to be(nil)
+      end
     end
 
     describe '#verify!' do

data/spec/firebase_id_token/signature_test_spec.rb

@@ -13,6 +13,10 @@ module FirebaseIdToken
       FirebaseIdToken.test!
     end
 
+    after :each do
+      FirebaseIdToken.reset
+    end
+
     describe '#verify' do
 
       it 'test mode is valid' do

data/spec/firebase_id_token_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe FirebaseIdToken do
 
   let (:mock_certificates) {
     allow(FirebaseIdToken::Certificates).to receive(:find).
-      with(an_instance_of(String)) {
+      with(an_instance_of(String), any_args) {
         OpenSSL::X509::Certificate.new(jwt['certificate']) }
   }
 

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ require 'httparty'
 require 'jwt'
 require 'firebase_id_token'
 require 'pry'
+require './spec/support/certificates_shared_examples'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

data/spec/support/certificates_shared_examples.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+# The ActiveSupport store lazily downloads certificates whenever it is
+# instantiated over an empty cache, while the legacy Redis store only
+# downloads them upon an explicit request. Examples whose outcome depends on
+# the empty-cache behavior branch on the `lazy` option.
+shared_examples_for 'a certificate store' do |opts = {}|
+  lazy = opts.fetch(:lazy, false)
+
+  before :each do
+    mock_request
+  end
+
+  describe '#request' do
+    it 'requests certificates when the cache is empty' do
+      expect(HTTParty).to receive(:get).
+        with(FirebaseIdToken::Certificates::URL)
+      described_class.request
+    end
+
+    it 'does not requests certificates when the cache is written' do
+      expect(HTTParty).to receive(:get).
+        with(FirebaseIdToken::Certificates::URL).once
+      2.times { described_class.request }
+    end
+  end
+
+  describe '#request!' do
+    if lazy
+      it 'always requests certificates' do
+        # The store lazily loads the empty cache once before the first
+        # explicit request, hence the extra call.
+        expect(HTTParty).to receive(:get).
+          with(FirebaseIdToken::Certificates::URL).exactly(3).times
+        2.times { described_class.request! }
+      end
+    else
+      it 'always requests certificates' do
+        expect(HTTParty).to receive(:get).
+          with(FirebaseIdToken::Certificates::URL).twice
+        2.times { described_class.request! }
+      end
+    end
+
+    it 'sets the certificate expiration time as the cache TTL' do
+      described_class.request!
+      expect(described_class.ttl).to be > 3600
+    end
+
+    it 'raises a error when certificates expires in less than 1 hour' do
+      allow(response).to receive(:headers) {{'cache-control' => low_cache}}
+        expect{ described_class.request! }.
+          to raise_error(FirebaseIdToken::Exceptions::CertificatesTtlError)
+    end
+
+    it 'raises a error when HTTP response code is other than 200' do
+      allow(response).to receive(:code) { 401 }
+      expect{ described_class.request! }.
+        to raise_error(FirebaseIdToken::Exceptions::CertificatesRequestError)
+    end
+  end
+
+  describe '#request_anyway' do
+    if lazy
+      it 'also requests certificates' do
+        expect(HTTParty).to receive(:get).
+          with(FirebaseIdToken::Certificates::URL).twice
+        described_class.request_anyway
+      end
+    else
+      it 'also requests certificates' do
+        expect(HTTParty).to receive(:get).
+          with(FirebaseIdToken::Certificates::URL)
+        described_class.request_anyway
+      end
+    end
+  end
+
+  describe '.present?' do
+    if lazy
+      it 'returns true when the cache is empty, lazily fetching' do
+        expect(described_class.present?).to be(true)
+      end
+    else
+      it 'returns false when the cache is empty' do
+        expect(described_class.present?).to be(false)
+      end
+    end
+
+    it 'returns true when the cache is written' do
+      described_class.request
+      expect(described_class.present?).to be(true)
+    end
+  end
+
+  describe '.all' do
+    context 'before requesting certificates' do
+      if lazy
+        it 'lazily fetches and returns the certificates' do
+          expect(described_class.all.first.values[0]).
+            to be_a(OpenSSL::X509::Certificate)
+        end
+      else
+        it 'returns a empty Array' do
+          expect(described_class.all).to eq([])
+        end
+      end
+    end
+
+    context 'after requesting certificates' do
+      it 'returns a array of hashes: String keys' do
+        described_class.request
+        expect(described_class.all.first.keys[0]).to be_a(String)
+      end
+
+      it 'returns a array of hashes: OpenSSL::X509::Certificate values' do
+        described_class.request
+        expect(described_class.all.first.values[0]).
+          to be_a(OpenSSL::X509::Certificate)
+      end
+    end
+  end
+
+  describe '.find' do
+    context 'without certificates in the cache' do
+      if lazy
+        it 'lazily fetches certificates and finds the kid' do
+          expect(described_class.find(kid)).to be_a(OpenSSL::X509::Certificate)
+        end
+      else
+        it 'raises a exception' do
+          expect{ described_class.find(kid)}.
+            to raise_error(FirebaseIdToken::Exceptions::NoCertificatesError)
+        end
+      end
+    end
+
+    context 'with certificates in the cache' do
+      it 'returns a OpenSSL::X509::Certificate when it finds the kid' do
+        described_class.request
+        expect(described_class.find(kid)).to be_a(OpenSSL::X509::Certificate)
+      end
+
+      it 'returns nil when it can not find the kid' do
+        described_class.request
+        expect(described_class.find('')).to be(nil)
+      end
+    end
+  end
+
+  describe '.find!' do
+    context 'without certificates in the cache' do
+      if lazy
+        it 'lazily fetches certificates and finds the kid' do
+          expect(described_class.find!(kid)).to be_a(OpenSSL::X509::Certificate)
+        end
+      else
+        it 'raises a exception' do
+          expect{ described_class.find!(kid)}.
+            to raise_error(FirebaseIdToken::Exceptions::NoCertificatesError)
+        end
+      end
+    end
+
+    context 'with certificates in the cache' do
+      it 'returns a OpenSSL::X509::Certificate when it finds the kid' do
+        described_class.request
+        expect(described_class.find!(kid)).to be_a(OpenSSL::X509::Certificate)
+      end
+
+      it 'raises a CertificateNotFound error when it can not find the kid' do
+        described_class.request
+        expect { described_class.find!('') }
+          .to raise_error(FirebaseIdToken::Exceptions::CertificateNotFound, /Unable to find/)
+      end
+    end
+
+  end
+
+  describe '.ttl' do
+    it 'returns a positive number when has certificates in the cache' do
+      described_class.request
+      expect(described_class.ttl).to be > 0
+    end
+
+    if lazy
+      it 'returns a positive number when the cache is empty, lazily fetching' do
+        expect(described_class.ttl).to be > 0
+      end
+    else
+      it 'returns zero when has no certificates in the cache' do
+        expect(described_class.ttl).to eq(0)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: firebase_id_token
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Fernando Schuindt
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +129,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.6
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -147,7 +146,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -158,16 +157,22 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +227,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.3
-description: A Ruby gem to verify the signature of Firebase ID Tokens. It uses Redis
+description: A Ruby gem to verify the signature of Firebase ID Tokens. It uses ActiveSupport::Cache
   to store Google's x509 certificates and manage their expiration time, so you don't
   need to request Google's API in every execution and can access it as fast as reading
   from memory.
@@ -239,7 +244,6 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -250,16 +254,22 @@ files:
 - firebase_id_token.gemspec
 - lib/firebase_id_token.rb
 - lib/firebase_id_token/certificates.rb
+- lib/firebase_id_token/certificates/active_support.rb
+- lib/firebase_id_token/certificates/redis.rb
 - lib/firebase_id_token/configuration.rb
 - lib/firebase_id_token/exceptions/certificate_not_found.rb
 - lib/firebase_id_token/exceptions/certificates_request_error.rb
 - lib/firebase_id_token/exceptions/certificates_ttl_error.rb
 - lib/firebase_id_token/exceptions/no_certificates_error.rb
+- lib/firebase_id_token/exceptions/unsupported_cache_operation_error.rb
 - lib/firebase_id_token/signature.rb
 - lib/firebase_id_token/testing/certificates.rb
 - lib/firebase_id_token/version.rb
-- spec/firebase_id_token/certificates_spec.rb
+- spec/firebase_id_token/certificates/active_support_spec.rb
+- spec/firebase_id_token/certificates/redis_spec.rb
+- spec/firebase_id_token/certificates_session_cookie_spec.rb
 - spec/firebase_id_token/configuration_spec.rb
+- spec/firebase_id_token/signature_session_cookie_spec.rb
 - spec/firebase_id_token/signature_spec.rb
 - spec/firebase_id_token/signature_test_spec.rb
 - spec/firebase_id_token_spec.rb
@@ -268,11 +278,11 @@ files:
 - spec/fixtures/files/jwt.json
 - spec/fixtures/files/payload.json
 - spec/spec_helper.rb
+- spec/support/certificates_shared_examples.rb
 homepage: https://github.com/fschuindt/firebase_id_token
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -287,8 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A Firebase ID Token verifier.
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at f.schuindtcs@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/spec/firebase_id_token/certificates_spec.rb

@@ -1,164 +0,0 @@
-require 'spec_helper'
-
-module FirebaseIdToken
-  describe Certificates do
-    let (:redis) { Redis::Namespace.new 'firebase_id_token', redis: Redis.new }
-    let (:certs) { File.read('spec/fixtures/files/certificates.json') }
-    let (:cache) { 'public, max-age=19302, must-revalidate, no-transform' }
-    let (:low_cache) { 'public, max-age=2160, must-revalidate, no-transform' }
-    let (:kid) { JSON.parse(certs).first[0] }
-    let (:expires_in) { (DateTime.now + (5/24r)).to_s }
-    let (:response) { double }
-
-    let (:mock_response) {
-      allow(response).to receive(:code) { 200 }
-      allow(response).to receive(:headers) { { 'cache-control' => cache } }
-      allow(response).to receive(:body) { certs }
-    }
-
-    let(:mock_request) {
-      mock_response
-      allow(HTTParty).to receive(:get).
-        with(an_instance_of(String)) { response }
-    }
-
-    before :each do
-      redis.del 'certificates'
-      mock_request
-    end
-
-    describe '#request' do
-      it 'requests certificates when Redis database is empty' do
-        expect(HTTParty).to receive(:get).
-          with(FirebaseIdToken::Certificates::URL)
-        described_class.request
-      end
-
-      it 'does not requests certificates when Redis database is written' do
-        expect(HTTParty).to receive(:get).
-          with(FirebaseIdToken::Certificates::URL).once
-        2.times { described_class.request }
-      end
-    end
-
-    describe '#request!' do
-      it 'always requests certificates' do
-        expect(HTTParty).to receive(:get).
-          with(FirebaseIdToken::Certificates::URL).twice
-        2.times { described_class.request! }
-      end
-
-      it 'sets the certificate expiration time as Redis TTL' do
-        described_class.request!
-        expect(redis.ttl('certificates')).to be > 3600
-      end
-
-      it 'raises a error when certificates expires in less than 1 hour' do
-        allow(response).to receive(:headers) {{'cache-control' => low_cache}}
-        expect{ described_class.request! }.
-          to raise_error(Exceptions::CertificatesTtlError)
-      end
-
-      it 'raises a error when HTTP response code is other than 200' do
-        allow(response).to receive(:code) { 401 }
-        expect{ described_class.request! }.
-          to raise_error(Exceptions::CertificatesRequestError)
-      end
-    end
-
-    describe '#request_anyway' do
-      it 'also requests certificates' do
-        expect(HTTParty).to receive(:get).
-          with(FirebaseIdToken::Certificates::URL)
-
-        described_class.request_anyway
-      end
-    end
-
-    describe '.present?' do
-      it 'returns false when Redis database is empty' do
-        expect(described_class.present?).to be(false)
-      end
-
-      it 'returns true when Redis database is written' do
-        described_class.request
-        expect(described_class.present?).to be(true)
-      end
-    end
-
-    describe '.all' do
-      context 'before requesting certificates' do
-        it 'returns a empty Array' do
-          expect(described_class.all).to eq([])
-        end
-      end
-
-      context 'after requesting certificates' do
-        it 'returns a array of hashes: String keys' do
-          described_class.request
-          expect(described_class.all.first.keys[0]).to be_a(String)
-        end
-
-        it 'returns a array of hashes: OpenSSL::X509::Certificate values' do
-          described_class.request
-          expect(described_class.all.first.values[0]).
-            to be_a(OpenSSL::X509::Certificate)
-        end
-      end
-    end
-
-    describe '.find' do
-      context 'without certificates in Redis database' do
-        it 'raises a exception' do
-          expect{ described_class.find(kid)}.
-            to raise_error(Exceptions::NoCertificatesError)
-        end
-      end
-
-      context 'with certificates in Redis database' do
-        it 'returns a OpenSSL::X509::Certificate when it finds the kid' do
-          described_class.request
-          expect(described_class.find(kid)).to be_a(OpenSSL::X509::Certificate)
-        end
-
-        it 'returns nil when it can not find the kid' do
-          described_class.request
-          expect(described_class.find('')).to be(nil)
-        end
-      end
-    end
-
-    describe '.find!' do
-      context 'without certificates in Redis database' do
-        it 'raises a exception' do
-          expect{ described_class.find!(kid)}.
-            to raise_error(Exceptions::NoCertificatesError)
-        end
-      end
-      context 'with certificates in Redis database' do
-        it 'returns a OpenSSL::X509::Certificate when it finds the kid' do
-          described_class.request
-          expect(described_class.find!(kid)).to be_a(OpenSSL::X509::Certificate)
-        end
-
-        it 'raises a CertificateNotFound error when it can not find the kid' do
-          described_class.request
-          expect { described_class.find!('') }
-            .to raise_error(Exceptions::CertificateNotFound, /Unable to find/)
-        end
-      end
-
-    end
-
-    describe '.ttl' do
-      it 'returns a positive number when has certificates in Redis' do
-        described_class.request
-        expect(described_class.ttl).to be > 0
-      end
-
-      it 'returns zero when has no certificates in Redis' do
-        expect(described_class.ttl).to eq(0)
-      end
-    end
-  end
-end