firebase_id_token 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e4caa21b36b9c1bc8383297066ee34391d8c3f5
+  data.tar.gz: 424f1dadf56dc853f1f3ce2b2130aa272494dca0
+SHA512:
+  metadata.gz: 3070735217a03083dd6f0ced71fc57f52954786b7adabcfdfb1f32f77aed9ab5904aac657012923d2ff68457250ee4f2948880372bed6f12868c9bcc4dbcea42
+  data.tar.gz: a6ffd3d4eabf61cfc7ce157dd749ae25923835f59360f171be37e076db8489cd4ba16412b3cf062c065aea7d00ec706b88a176a2503d3f3a8f504417ef9d108d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.yardopts

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6
+services:
+  - redis-server

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in firebase_id_token.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Fernando Schuindt
+
+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,178 @@
+# Ruby Firebase ID Token verifier (pre-release)
+
+![Alt text](https://api.travis-ci.org/fschuindt/firebase_id_token.svg?branch=master)
+[![Code Climate](https://codeclimate.com/github/fschuindt/firebase_id_token/badges/gpa.svg)](https://codeclimate.com/github/fschuindt/firebase_id_token)
+[![Issue Count](https://codeclimate.com/github/fschuindt/firebase_id_token/badges/issue_count.svg)](https://codeclimate.com/github/fschuindt/firebase_id_token)
+[![Test Coverage](https://codeclimate.com/github/fschuindt/firebase_id_token/badges/coverage.svg)](https://codeclimate.com/github/fschuindt/firebase_id_token/coverage)
+
+A Ruby gem to verify the signature of Firebase ID Tokens. It uses Redis 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.
+
+It also checks the JWT payload parameters as recommended [here](https://firebase.google.com/docs/auth/admin/verify-id-tokens) by Firebase official documentation.
+
+## Pre-release Notes
+
+**This gem was developed recently and needs real world feedback.**
+
+If you are going to use it in production environment, please note that I am still testing it. It has realistc RSpec examples that uses real X509 certificates and signed JWT to perform tests and I can say it's working great. But using it implies in security risks, you should be aware.
+
+Feel free to open any issue or to [contact me](https://fschuindt.github.io/blog/about/) regarding it's performance.
+
+## Docs
+
+ + http://www.rubydoc.info/gems/firebase_id_token
+
+## Requirements
+
++ Redis
+
+## Installing
+
+```
+gem install firebase_id_token
+```
+
+or in your Gemfile
+```
+gem 'firebase_id_token'
+```
+then
+```
+bundle install
+```
+
+## Configuration
+
+It's needed to set up your Firebase Project ID.
+
+If you are using Rails, this should probably go into `config/initializers/firebase_id_token.rb`.
+
+```ruby
+FirebaseIdToken.configure do |config|
+  config.project_ids = ['your-firebase-project-id']
+end
+```
+
+`project_ids` must be a Array.
+
+*If you want to verify signatures from more than one Firebase project, just add more Project IDs to the list.*
+
+You can also pass a Redis instance to `config` if you are not using Redis defaults.  
+In this case you must have the gem `redis` in your `Gemfile`.
+```ruby
+FirebaseIdToken.configure do |config|
+  config.project_ids = ['your-firebase-project-id']
+  congig.redis = Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+end
+```
+
+Otherwise it will use just `Redis.new` as the instance.
+
+## Usage
+
+### Downloading Certificates
+
+Before verifying tokens, you need to download Google's x509 certificates.
+
+To do it simply:
+```ruby
+FirebaseIdToken::Certificates.request
+```
+
+It will download the certificates and save it in Redis, but only if Redis certificates database is empty. To force download and override Redis database, use:
+```ruby
+FirebaseIdToken::Certificates.request_anyway
+```
+
+Google give us information about the certificates expiration time, it's used to set a Redis TTL (Time-To-Live) when saving it. By doing so, the certificates will be automatically deleted after it's expiration.
+
+You can access informations about it:
+```ruby
+# Boolean representing the presence of certificates in Redis database.
+FirebaseIdToken::Certificates.present?
+=> true
+
+# How many seconds until the certificates expiration.
+FirebaseIdToken::Certificates.ttl
+=> 22352
+
+# List of all certificates in database.
+FirebaseIdToken::Certificates.all
+=> [{"ec8f292sd30224afac5c55540df66d1f999d" => <OpenSSL::X509::Certificate: [...]
+
+# Returns the respective certificate of a given Key ID.
+FirebaseIdToken::Certificates.find('ec8f292sd30224afac5c55540df66d1f999d')
+=> <OpenSSL::X509::Certificate: subject=<OpenSSL::X509 [...]
+
+```
+
+#### Downloading in Rails
+
+If you are using Rails it's preferred that you download the certificates in a background job, you can use [ActiveJob](http://guides.rubyonrails.org/active_job_basics.html) in this case.
+```ruby
+class RequestCertificatesJob < ApplicationJob
+  queue_as :default
+
+  def perform
+    FirebaseIdToken::Certificates.request_anyway
+  end
+end
+```
+
+Then set it as a cron job, I recommend running it once every hour or every 30 minutes, it's up to you. Normally the certificates expiration time is around 5 to 6 hours, but it's good to perform it in a small fraction of this time.
+
+You can use [whenever](https://github.com/javan/whenever) to do this.
+
+### Verifying Tokens
+
+Pass the Firebase ID Token to `FirebaseIdToken::Signature.verify` and it will return the token payload if everything is ok:
+
+```ruby
+FirebaseIdToken::Signature.verify(token)
+=> {"iss"=>"https://securetoken.google.com/firebase-id-token", "name"=>"Bob Test", [...]
+```
+
+When either the signature is false or the token is invalid, it will return `nil`:
+```ruby
+FirebaseIdToken::Signature.verify(fake_token)
+=> nil
+
+FirebaseIdToken::Signature.verify('aaaaaa')
+=> nil
+```
+
+**WARNING:** If you try to verify a signature without any certificates in Redis database it will raise a `FirebaseIdToken::Exceptions::NoCertificatesError`.
+
+#### Payload Structure
+
+In case you need, here's a example of the payload structure in JSON.
+```json
+{  
+   "iss":"https://securetoken.google.com/firebase-id-token",
+   "name":"Ugly Bob",
+   "picture":"https://someurl.com/photo.jpg",
+   "aud":"firebase-id-token",
+   "auth_time":1492981192,
+   "user_id":"theUserID",
+   "sub":"theUserID",
+   "iat":1492981200,
+   "exp":33029000017,
+   "email":"uglybob@emailurl.com",
+   "email_verified":true,
+   "firebase":{  
+      "identities":{  
+         "google.com":[  
+            "1010101010101010101"
+         ],
+         "email":[  
+            "uglybob@emailurl.com"
+         ]
+      },
+      "sign_in_provider":"google.com"
+   }
+}
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "firebase_id_token"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/firebase_id_token.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebase_id_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'firebase_id_token'
+  spec.version       = FirebaseIdToken::VERSION
+  spec.authors       = ['Fernando Schuindt']
+  spec.email         = ['f.schuindtcs@gmail.com']
+
+  spec.summary       = 'A Firebase ID Token verifier.'
+  spec.description   = "A Ruby gem to verify the signature of Firebase ID "\
+    "Tokens. It uses Redis 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."
+  spec.homepage      = 'https://github.com/fschuindt/firebase_id_token'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+
+  spec.add_dependency 'redis', '~> 3.3.3'
+  spec.add_dependency 'redis-namespace', '~> 1.5.3'
+  spec.add_dependency 'httparty', '~> 0.14.0'
+  spec.add_dependency 'jwt', '~> 1.5.6'
+end

data/lib/firebase_id_token.rb

@@ -0,0 +1,57 @@
+require 'redis'
+require 'redis-namespace'
+require 'httparty'
+require 'jwt'
+
+require 'firebase_id_token/version'
+require 'firebase_id_token/exceptions/no_certificates_error'
+require 'firebase_id_token/exceptions/certificates_request_error'
+require 'firebase_id_token/exceptions/certificates_ttl_error'
+require 'firebase_id_token/configuration'
+require 'firebase_id_token/certificates'
+require 'firebase_id_token/signature'
+
+# ## List of available methods
+# + {Certificates.request}
+# + {Certificates.request_anyway}
+# + {Certificates.present?}
+# + {Certificates.all}
+# + {Certificates.ttl}
+# + {Certificates.find}
+# + {Signature.verify}
+#
+# ## Configuration
+#
+# You need to set your Firebase Project ID. Additionally you can set your Redis
+# server instance in case you don't use Redis defaults.
+#
+# **WARNING:** Your `project_ids` must be a `Array`.
+# ```
+# FirebaseIdToken.configure do |config|
+#   config.project_ids = ['my-project-id', 'another-project-id']
+#   congig.redis = Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+# end
+# ```
+#
+# **Defaults**
+# + `project_ids` => `[]`
+# + `redis` => `Redis.new`
+#
+module FirebaseIdToken
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Resets Configuration to defaults.
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/firebase_id_token/certificates.rb

@@ -0,0 +1,170 @@
+module FirebaseIdToken
+  # Manage download and access of Google's x509 certificates. Keeps
+  # certificates on a Redis namespace database.
+  #
+  # ## Download & Access Certificates
+  #
+  # It describes two ways to download it: {.request} and {.request_anyway}.
+  # The first will only do something when Redis certificates database is empty,
+  # the second one will always request a new download to Google's API and
+  # override the database with the response.
+  #
+  # It's important to note that when saving a set of certificates, it will also
+  # set a Redis expiration time to match Google's API header `expires`. **After
+  # this time went out, Redis will automatically delete those certificates.**
+  #
+  # *To know how many seconds left until the expiration you can use {.ttl}.*
+  #
+  # When comes to accessing it, you can either use {.present?} to check if
+  # there's any data inside Redis certificates database or {.all} to obtain a
+  # `Array` of current certificates.
+  #
+  # @example `.request` will only download once
+  #   FirebaseIdToken::Certificates.request # Downloads certificates.
+  #   FirebaseIdToken::Certificates.request # Won't do anything.
+  #   FirebaseIdToken::Certificates.request # Won't do anything either.
+  #
+  # @example `.request_anyway` will download always
+  #   FirebaseIdToken::Certificates.request # Downloads certificates.
+  #   FirebaseIdToken::Certificates.request_anyway # Downloads certificates.
+  #   FirebaseIdToken::Certificates.request_anyway # Downloads certificates.
+  #
+  class Certificates
+    # A Redis instance.
+    attr_reader :redis
+    # Certificates saved in the Redis (JSON `String` or `nil`).
+    attr_reader :local_certs
+
+    # Google's x509 certificates API URL.
+    URL = 'https://www.googleapis.com/robot/v1/metadata/x509/'\
+      'securetoken@system.gserviceaccount.com'
+
+    # Calls {.request_anyway} only if there's no certificates on Redis. It will
+    # return `nil` otherwise.
+    #
+    # It will raise {Exceptions::CertificatesRequestError} if the request
+    # fails or {Exceptions::CertificatesTtlError} when Google responds with a
+    # low TTL, check out {.request_anyway} for more info.
+    #
+    # @return [nil, Hash]
+    # @see Certificates.request_anyway
+    def self.request
+      new.request
+    end
+
+    # Triggers a HTTPS request to Google's x509 certificates API. If it
+    # responds with a status `200 OK`, saves the request body into Redis and
+    # returns it as a `Hash`.
+    #
+    # Otherwise it will raise a {Exceptions::CertificatesRequestError}.
+    #
+    # This is really rare to happen, but Google may respond with a low TTL
+    # certificate. This is a `SecurityError` and will raise a
+    # {Exceptions::CertificatesTtlError}. You are mostly like to never face it.
+    # @return [Hash]
+    def self.request_anyway
+      new.request_anyway
+    end
+
+    # Returns `true` if there's certificates data on Redis, `false` otherwise.
+    # @example
+    #   FirebaseIdToken::Certificates.present? #=> false
+    #   FirebaseIdToken::Certificates.request
+    #   FirebaseIdToken::Certificates.present? #=> true
+    def self.present?
+      ! new.local_certs.empty?
+    end
+
+    # Returns a array of hashes, each hash is a single `{key => value}` pair
+    # containing the certificate KID `String` as key and a
+    # `OpenSSL::X509::Certificate` object of the respective certificate as
+    # value. Returns a empty `Array` when there's no certificates data on
+    # Redis.
+    # @return [Array]
+    # @example
+    #   FirebaseIdToken::Certificates.request
+    #   certs = FirebaseIdToken::Certificates.all
+    #   certs.first #=> {"1d6d01c7[...]" => #<OpenSSL::X509::Certificate[...]}
+    def self.all
+      new.local_certs.map { |kid, cert|
+        { kid => OpenSSL::X509::Certificate.new(cert) } }
+    end
+
+    # Returns a `OpenSSL::X509::Certificate` object of the requested Key ID
+    # (KID) if there's one. Returns `nil` otherwise.
+    #
+    # It will raise a {Exceptions::NoCertificatesError} if the Redis
+    # certificates database is empty.
+    # @param [String] kid Key ID
+    # @return [nil, OpenSSL::X509::Certificate]
+    # @example
+    #   FirebaseIdToken::Certificates.request
+    #   cert = FirebaseIdToken::Certificates.find "1d6d01f4w7d54c7[...]"
+    #   #=> <OpenSSL::X509::Certificate: subject=#<OpenSSL [...]
+    def self.find(kid)
+      certs = new.local_certs
+      raise Exceptions::NoCertificatesError if certs.empty?
+
+      if certs[kid]
+        OpenSSL::X509::Certificate.new certs[kid]
+      end
+    end
+
+    # Returns the current certificates TTL (Time-To-Live) in seconds. *Zero
+    # meaning no certificates.* It's the same as the certificates expiration
+    # time, use it to know when to request again.
+    # @return [Fixnum]
+    def self.ttl
+      ttl = new.redis.ttl('certificates')
+      ttl < 0 ? 0 : ttl
+    end
+
+    # Sets two instance attributes: `:redis` and `:local_certs`. Those are
+    # respectively a Redis instance from {FirebaseIdToken::Configuration} and
+    # the certificates in it.
+    def initialize
+      @redis = Redis::Namespace.new('firebase_id_token',
+        redis: FirebaseIdToken.configuration.redis)
+      @local_certs = read_certificates
+    end
+
+    # @see Certificates.request
+    def request
+      request_anyway if @local_certs.empty?
+    end
+
+    # @see Certificates.request_anyway
+    def request_anyway
+      @request = HTTParty.get URL
+      code = @request.code
+      if code == 200
+        save_certificates
+      else
+        raise Exceptions::CertificatesRequestError.new(code)
+      end
+    end
+
+    private
+
+    def read_certificates
+      certs = @redis.get 'certificates'
+      certs ? JSON.parse(certs) : {}
+    end
+
+    def save_certificates
+      @redis.setex 'certificates', ttl, @request.body
+      @local_certs = read_certificates
+    end
+
+    def ttl
+      ttl = DateTime.parse(@request.headers['expires']).
+        to_time.to_i - Time.now.to_i
+
+      if ttl > 3600
+        ttl
+      else
+        raise Exceptions::CertificatesTtlError
+      end
+    end
+  end
+end

data/lib/firebase_id_token/configuration.rb

@@ -0,0 +1,12 @@
+module FirebaseIdToken
+  # Handles the configuration object. Check out {FirebaseIdToken} for more
+  # info on how to use it.
+  class Configuration
+    attr_accessor :redis, :project_ids
+
+    def initialize
+      @redis = Redis.new
+      @project_ids = []
+    end
+  end
+end

data/lib/firebase_id_token/exceptions/certificates_request_error.rb

@@ -0,0 +1,11 @@
+module FirebaseIdToken
+  module Exceptions
+    # @see FirebaseIdToken::Certificates.request
+    # @see FirebaseIdToken::Certificates.request_anyway
+    class CertificatesRequestError < StandardError
+      def initialize(code)
+        super "#{code} HTTP status when requesting Google's certificates."
+      end
+    end
+  end
+end

data/lib/firebase_id_token/exceptions/certificates_ttl_error.rb

@@ -0,0 +1,11 @@
+module FirebaseIdToken
+  module Exceptions
+    # @see FirebaseIdToken::Certificates.request
+    # @see FirebaseIdToken::Certificates.request_anyway
+    class CertificatesTtlError < StandardError
+      def initialize(message = "Google's x509 certificates has a low TTL.")
+        super message
+      end
+    end
+  end
+end

data/lib/firebase_id_token/exceptions/no_certificates_error.rb

@@ -0,0 +1,10 @@
+module FirebaseIdToken
+  module Exceptions
+    # @see FirebaseIdToken::Certificates.find
+    class NoCertificatesError < StandardError
+      def initialize(message = "There's no certificates in Redis database.")
+        super message
+      end
+    end
+  end
+end

data/lib/firebase_id_token/signature.rb

@@ -0,0 +1,105 @@
+module FirebaseIdToken
+  # Deals with verifying if a given Firebase ID Token is signed by one of the
+  # Google's x509 certificates that Firebase uses.
+  #
+  # Also checks if the resulting JWT payload hash matches with:
+  # + `exp` Expiration time
+  # + `iat` Issued at time
+  # + User's Firebase Project ID
+  # + Non-empty UID
+  #
+  # ## Verifying a Firebase ID Token
+  #
+  # *Be sure to configure the gem to set your Firebase Project ID and a Redis
+  # server before move any forward.*
+  #
+  # **See the README for a complete guide.**
+  #
+  # **WARNING:** Trying to verify a token without any certificate saved in
+  # Redis certificates database raises a {Exceptions::NoCertificatesError}.
+  #
+  # @example
+  #   FirebaseIdToken::Signature.verify(thrusty_token)
+  #   => {"iss"=>"https://securetoken.google.com/your-project-id", [...]}
+  #
+  #   FirebaseIdToken::Signature.verify(fake_token)
+  #   => nil
+  #
+  # @see Signature#verify
+  class Signature
+    # Pre-default JWT algorithm parameters as recommended
+    # [here](https://goo.gl/uOK5Jx).
+    JWT_DEFAULTS = { algorithm: 'RS256', verify_iat: true }
+
+    # Returns the decoded JWT hash payload of the Firebase ID Token if the
+    # signature in the token matches with one of the certificates downloaded
+    # by {FirebaseIdToken::Certificates.request}, returns `nil` otherwise.
+    #
+    # It will also return `nil` when it fails in checking if all the required
+    # JWT fields are valid, as recommended [here](https://goo.gl/yOrZZX) by
+    # Firebase oficial documentation.
+    #
+    # Note that it will raise a {Exceptions::NoCertificatesError} if the Redis
+    # certificates database is empty. Ensure to call {Certificates.request}
+    # before, ideally in a background job if you are using Rails.
+    # @return [nil, Hash]
+    def self.verify(jwt_token)
+      new(jwt_token).verify
+    end
+
+    # Loads attributes: `:project_ids` from {FirebaseIdToken::Configuration},
+    # and `:kid`, `:jwt_token` from the related `jwt_token`.
+    # @param [String] jwt_token Firebase ID Token
+    def initialize(jwt_token)
+      @project_ids = FirebaseIdToken.configuration.project_ids
+      @kid = extract_kid(jwt_token)
+      @jwt_token = jwt_token
+    end
+
+    # @see Signature.verify
+    def verify
+      certificate = FirebaseIdToken::Certificates.find(@kid)
+      if certificate
+        payload = decode_jwt_payload(@jwt_token, certificate.public_key)
+        authorize payload
+      end
+    end
+
+    private
+
+    def extract_kid(jwt_token)
+      JWT.decode(jwt_token, nil, false).last['kid']
+    rescue StandardError
+      'none'
+    end
+
+    def decode_jwt_payload(token, cert_key)
+      JWT.decode(token, cert_key, true, JWT_DEFAULTS).first
+    rescue StandardError
+      nil
+    end
+
+    def authorize(payload)
+      if payload && authorized?(payload)
+        payload
+      end
+    end
+
+    def authorized?(payload)
+      still_valid?(payload) &&
+      @project_ids.include?(payload['aud']) &&
+      issuer_authorized?(payload) &&
+      ! payload['sub'].empty?
+    end
+
+    def still_valid?(payload)
+      payload['exp'].to_i > Time.now.to_i &&
+      payload['iat'].to_i < Time.now.to_i
+    end
+
+    def issuer_authorized?(payload)
+      issuers = @project_ids.map { |i| "https://securetoken.google.com/#{i}" }
+      issuers.include? payload['iss']
+    end
+  end
+end

data/lib/firebase_id_token/version.rb

@@ -0,0 +1,3 @@
+module FirebaseIdToken
+  VERSION = "1.1.0"
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: firebase_id_token
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Fernando Schuindt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+description: A Ruby gem to verify the signature of Firebase ID Tokens. It uses Redis
+  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.
+email:
+- f.schuindtcs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase_id_token.gemspec
+- lib/firebase_id_token.rb
+- lib/firebase_id_token/certificates.rb
+- lib/firebase_id_token/configuration.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/signature.rb
+- lib/firebase_id_token/version.rb
+homepage: https://github.com/fschuindt/firebase_id_token
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Firebase ID Token verifier.
+test_files: []