firebase-auth-id_token 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 822d4f0601cbbdac7efce34d4b31866a7bf5e569ffbd4b33e845eb7d9b9710ba
+  data.tar.gz: a1536538c494c309af524723085662f27c2adb8731fec045708e929cba6f5dc0
+SHA512:
+  metadata.gz: ba1c9d5523b981f0df3f9e22f0cf65907f8201697b628f0e7af3a1035f673c4cdb1e85f9e6d42d5f1ba462ee25637e9afcef1e8a116e0f5d15e44afebc902c10
+  data.tar.gz: ec0e06327ec38afd735e8d6f54589121c7e259f866db1d9617bb31443a9eede0e50b05bc7c89178da5755c24ece9a20f2234940a1df408a71d5dc075a3678639

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

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 takehiro0740@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in firebase-auth-id_token.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'webrick'
+gem 'vcr'
+gem 'webmock'
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    firebase-auth-id_token (0.1.0)
+      jwt (~> 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.1)
+    jwt (2.2.1)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    safe_yaml (1.0.5)
+    vcr (5.1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  firebase-auth-id_token!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+  webrick
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Takehiro Adachi
+
+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,108 @@
+# Firebase Auth ID token verifier
+
+## Installation
+
+Add the following line to your Gemfile:
+
+```ruby
+gem 'firebase-auth-id_token'
+```
+
+Then run `bundle install`
+
+Set the following config code as `config/initializers/firebase-auth-id_token.rb`
+
+```ruby
+Firebase::Auth::IDToken.configure do |config|
+  config.project_id = 'YOUR_FIREBASE_PROJECT_ID'
+end
+```
+
+`YOUR_FIREBASE_PROJECT_ID` could be found at https://console.firebase.google.com
+
+## Usage
+
+Use `Firebase::Auth::IDToken#verify!` as below
+
+### Rails API
+
+```ruby
+class ApplicationController < ActionController::API
+  before_action :verify_auth_token!
+  before_action :authenticate_user!
+
+  protected
+
+  def authenticate_user!
+    User.find_by!(uid: @auth_token_payload['sub'])
+  rescue ActiveRecord::RecordNotFound
+    head :unauthorized
+  end
+
+  def verify_auth_token!
+    @auth_token_payload = Firebase::Auth::IDToken.new(auth_id_token).verify!
+  # You should refetch ID token on the client side if you receive this 401
+  rescue Firebase::Auth::IDToken::Error::Expired
+    render json: { error: { message: 'Auth ID token expired' } }, status: :unauthorized
+  rescue Firebase::Auth::IDToken::Error::VerificationFail
+    # Notifying to Bugsnag/Sentry here will be nice
+    head :unauthorized
+  end
+
+  private
+
+  def auth_id_token
+    request.headers['Authorization']
+  end
+end
+```
+
+```ruby
+class UsersController < ApplicationController
+  skip_before_action :authenticate_user!
+
+  def create
+    @user = User.new(user_params)
+
+    if @user.save
+      head :created
+    else
+      render json: { errors: @user.errors.full_messages }
+    end
+  end
+
+  private
+
+  def user_params
+    params.require(:user)
+          .permit(:name)
+          .merge(firebase_auth_uid: @auth_token_payload['sub'])
+  end
+end
+```
+
+## Errors
+
+### Important ones
+
+* `Firebase::Auth::IDToken::Error::ProjectIdNotSet` - raised if you haven't set `project_id`
+* `Firebase::Auth::IDToken::Error::Expired` - raised when the given token is expired, you should return an error code(e.g. 401) to the client so the client can refetch a new token
+
+### Others
+
+The following errors will basically be raised when the token is either unable to decode, or invalid.
+These shouldn't be raised in normal use case, so rescuing the parent class(which is `~::VerificationFail`) and notifying to error monitoring service might be good(see `Usage` section).
+
+* `Firebase::Auth::IDToken::Error::Expired`
+* `Firebase::Auth::IDToken::Error::CannotDecode`
+* `Firebase::Auth::IDToken::Error::IncorrectAlgorithm`
+* `Firebase::Auth::IDToken::Error::InvalidIat`
+* `FireBase::Auth::IDToken::Error::InvalidAud`
+* `FireBase::Auth::IDToken::Error::InvalidIssuer`
+* `FireBase::Auth::IDToken::Error::InvalidSub`
+* `FireBase::Auth::IDToken::Error::InvalidAuthTime`
+
+## FAQs
+
+* Q. How to retrieve user informations?
+* A. Best way right now would be by using [googleapis/google-api-ruby-client](https://github.com/googleapis/google-api-ruby-client)'s `Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest`. [Sample code]()

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/auth/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-auth-id_token.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/firebase/auth/id_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebase-auth-id_token"
+  spec.version       = Firebase::Auth::IDToken::VERSION
+  spec.authors       = ["Takehiro Adachi"]
+  spec.email         = ["takehiro0740@gmail.com"]
+
+  spec.summary       = %q{Small gem which verifies your firebase auth ID token in server side}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/take/firebase-auth-id_token"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/take/firebase-auth-id_token/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency 'jwt', '~> 2.2.0'
+end

data/lib/firebase/auth/id_token.rb

@@ -0,0 +1,89 @@
+require 'firebase/auth/id_token/version'
+require 'firebase/auth/id_token/config'
+require 'firebase/auth/id_token/errors'
+require 'firebase/auth/id_token/public_keys'
+require 'jwt'
+
+module Firebase
+  module Auth
+    class IDToken
+
+      class << self
+        def configure
+          yield config
+        end
+
+        def config
+          @config ||= Config.new
+        end
+      end
+
+      def initialize(token)
+        @token = token
+        raise Error::ProjectIdNotSet.new('project_id is not set, please set') unless self.class.config.project_id
+      end
+
+      def verify!
+        decode!
+        set_certificate
+        verify_decoded_token!
+        verify_token!
+
+        [@payload, @header]
+      end
+
+      private
+
+      # https://firebase.google.com/docs/auth/admin/verify-id-tokens#verify_id_tokens_using_a_third-party_jwt_library
+      def decode!
+        @payload, @header = JWT.decode(@token, nil, false)
+      rescue JWT::DecodeError => e
+        raise Error::CannotDecode.new(e.message)
+      end
+
+      def set_certificate
+        @certificate ||= public_keys.find_by!(kid: @header['kid']).certificate
+      end
+
+      def verify_decoded_token!
+        raise Error::InvalidSub.new('Subject Claim should not be empty') if !@payload['sub'] || @payload['sub'] == ''
+        raise Error::InvalidAuthTime.new('Auth Time is lacking') unless @payload['auth_time']
+        raise Error::InvalidAuthTime.new('Auth Time is in future') if Time.now <= Time.at(@payload['auth_time'])
+      end
+
+      def verify_token!
+        JWT.decode(@token, @certificate.public_key, true,
+                   {
+                     verify_aud: true,
+                     aud: self.class.config.project_id,
+                     verify_iss: true,
+                     iss: iss,
+                     verify_iat: true,
+                     verify_sub: true,
+                     algorithms: ['RS256'],
+                   }
+                  )
+      rescue JWT::ExpiredSignature => e
+        raise Error::Expired.new(e.message)
+      rescue JWT::IncorrectAlgorithm => e
+        raise Error::IncorrectAlgorithm.new(e.message)
+      rescue JWT::InvalidIatError => e
+        raise Error::InvalidIat.new(e.message)
+      rescue JWT::InvalidAudError => e
+        raise Error::InvalidAud.new(e.message)
+      rescue JWT::InvalidIssuerError => e
+        raise Error::InvalidIssuer.new(e.message)
+      rescue JWT::DecodeError => e
+        raise Error::CannotDecode.new(e.message)
+      end
+
+      def iss
+        "https://securetoken.google.com/#{self.class.config.project_id}"
+      end
+
+      def public_keys
+        @public_keys ||= PublicKeys.new
+      end
+    end
+  end
+end

data/lib/firebase/auth/id_token/config.rb

@@ -0,0 +1,9 @@
+module Firebase
+  module Auth
+    class IDToken
+      class Config
+        attr_accessor :project_id
+      end
+    end
+  end
+end

data/lib/firebase/auth/id_token/errors.rb

@@ -0,0 +1,20 @@
+module Firebase
+  module Auth
+    class IDToken
+      class Error
+        class ProjectIdNotSet < StandardError ; end
+
+        class VerificationFail < StandardError ; end
+
+        class Expired < VerificationFail ; end
+        class CannotDecode < VerificationFail ; end
+        class IncorrectAlgorithm < VerificationFail ; end
+        class InvalidIat < VerificationFail ; end
+        class InvalidAud < VerificationFail ; end
+        class InvalidIssuer < VerificationFail ; end
+        class InvalidSub < VerificationFail ; end
+        class InvalidAuthTime < VerificationFail ; end
+      end
+    end
+  end
+end

data/lib/firebase/auth/id_token/public_keys.rb

@@ -0,0 +1,51 @@
+require 'json'
+require 'open-uri'
+
+module Firebase
+  module Auth
+    class IDToken
+      class PublicKeys < Array
+        PUBLIC_KEYS_URI = 'https://www.googleapis.com/robot/v1/metadata/x509/securetoken@system.gserviceaccount.com'
+        private_constant :PUBLIC_KEYS_URI
+
+        class NotFound < StandardError ; end
+        class FailedToFetchFromRemote < StandardError ; end
+
+        def initialize
+          public_keys_from_remote.each do |kid, certificate|
+            self << PublicKey.new(kid: kid, certificate: certificate)
+          end
+        end
+
+        def find_by!(kid:)
+          public_key = self.find { |public_key| public_key.kid == kid }
+
+          raise NotFound unless public_key
+
+          public_key
+        end
+
+        private
+
+        def public_keys_from_remote
+          begin
+            JSON.parse(URI.open(PUBLIC_KEYS_URI).read)
+          rescue OpenURI::HTTPError => e
+            raise FailedToFetchFromRemote.new(e.io.status[1])
+          end
+        end
+      end
+
+      private
+
+      class PublicKey
+        attr_reader :kid, :certificate
+
+        def initialize(kid:, certificate:)
+          @kid = kid
+          @certificate = OpenSSL::X509::Certificate.new(certificate)
+        end
+      end
+    end
+  end
+end

data/lib/firebase/auth/id_token/version.rb

@@ -0,0 +1,7 @@
+module Firebase
+  module Auth
+    class IDToken
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: firebase-auth-id_token
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takehiro Adachi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: ''
+email:
+- takehiro0740@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase-auth-id_token.gemspec
+- lib/firebase/auth/id_token.rb
+- lib/firebase/auth/id_token/config.rb
+- lib/firebase/auth/id_token/errors.rb
+- lib/firebase/auth/id_token/public_keys.rb
+- lib/firebase/auth/id_token/version.rb
+homepage: https://github.com/take/firebase-auth-id_token
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/take/firebase-auth-id_token
+  source_code_uri: https://github.com/take/firebase-auth-id_token
+  changelog_uri: https://github.com/take/firebase-auth-id_token/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Small gem which verifies your firebase auth ID token in server side
+test_files: []