firebase_idtoken 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3493efd8dfd103e00f1610f82ac6d2e9336803fa551a9d25d614ab5e5b9ec138
+  data.tar.gz: bd346bdd9d4b6172ef13a28f0a5ce60d35f9bce74d955732e341e5f24bb913c6
+SHA512:
+  metadata.gz: 4e89aca9efae5fd67fd99d7dea16d8458f12cc3327b7d489148fe94135e380ace3001a4906cac7347b481571801fef5345781e5b951dddcd3c389e9ee8340e45
+  data.tar.gz: 6d86abecbb28cec372e33dfd72fc729b5dec3073ff365d05531e001bb7a6a7e5e1bc2d97820b85658253549aad3e41ff4593279bf809b1f86cde550853e25bdd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/bundle
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in firebase_idtoken.gemspec
+gemspec
+
+gem 'pry'
+gem 'pry-stack_explorer'
+gem 'awesome_print'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    firebase_idtoken (0.1.0)
+      jwt (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.2)
+    debug_inspector (0.0.3)
+    jwt (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.16)
+  firebase_idtoken!
+  pry
+  pry-stack_explorer
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 shunwitter
+
+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,72 @@
+# FirebaseIdtoken
+
+Retrieved auth UID using ID token sent from client. (Ruby implementation)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firebase_idtoken'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebase_idtoken
+
+## Configuration
+
+```ruby
+FirebaseIdtoken.configure do |config|
+  config.project_ids = 'my-project-id'      # Default: nil
+  config.cache_path  = 'path/to/cache_file' # Default: tmp/firebase_public_key
+  config.cache_time  = 60 * 60 * 2          # Default: 60 * 60
+end
+```
+
+## Usage
+
+```ruby
+require('firebase_idtoken')
+
+# Token comes from client side
+token = 'eyJhbGciOiJSUzI1NiIs.....ajmRoVHvI7A'
+FirebaseIdtoken.verify(token)
+
+# Result
+=> {"uid"=>"oyvaFVD2xxxxxxxxZPFVnH1X8Xv1",
+ "decoded_token"=>
+  {:payload=>
+    {"iss"=>"https://securetoken.google.com/your-project",
+     "name"=>"User Name",
+     "picture"=>
+      "https://lh5.googleusercontent.com/-xxxxxx/xxxxxxxxx/AAAAAAAAAT4/xxxxxxx/photo.jpg",
+     "aud"=>"your-project",
+     "auth_time"=>1522240359,
+     "user_id"=>"oyvaFVD2xxxxxxxxZPFVnH1X8Xv1",
+     "sub"=>"oyvaFVD2xxxxxxxxZPFVnH1X8Xv1",
+     "iat"=>1522240388,
+     "exp"=>1522243988,
+     "email"=>"youremail@example.com",
+     "email_verified"=>true,
+     "firebase"=>
+      {"identities"=>
+        {"google.com"=>["108658900000000862749"],
+         "email"=>["youremail@example.com"]},
+       "sign_in_provider"=>"google.com"}},
+   :header=>
+    {"alg"=>"RS256", "kid"=>"f5b18276a4866100000000c3e9434974d1f1db51"}}}
+```
+
+## Related Docs
+- https://firebase.google.com/docs/auth/admin/verify-id-tokens
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "firebase_idtoken"
+
+# 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_idtoken.gemspec

@@ -0,0 +1,23 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebase_idtoken/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'firebase_idtoken'
+  spec.version       = FirebaseIdtoken::VERSION
+  spec.authors       = ['shunwitter']
+
+  spec.summary       = %q{Ruby implementation to verify Google firebase ID token}
+  spec.description   = %q{Retrieved UID on server side using ID token sent from client}
+  spec.homepage      = 'https://github.com/shunwitter/firebase_idtoken'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jwt', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/firebase_idtoken/configuration.rb

@@ -0,0 +1,9 @@
+class FirebaseIdtoken::Configuration
+  attr_accessor :project_id, :cache_path, :cache_time
+
+  def initialize
+    @project_id = nil
+    @cache_path = 'tmp/firebase_public_key'
+    @cache_time = 60 * 60
+  end
+end

data/lib/firebase_idtoken/version.rb

@@ -0,0 +1,3 @@
+module FirebaseIdtoken
+  VERSION = "0.1.2"
+end

data/lib/firebase_idtoken.rb

@@ -0,0 +1,145 @@
+require 'fileutils'
+require 'net/http'
+require 'jwt'
+
+require "firebase_idtoken/version"
+require 'firebase_idtoken/configuration'
+
+module FirebaseIdtoken
+
+  # -------------------------------------------
+  # Config
+  #
+  # FirebaseIdtoken.configure do |config|
+  #   config.project_ids = 'my-project-id'
+  #   config.cache_path = 'path/to/cache_file'
+  #   config.cache_time = 60 * 60 * 2
+  # end
+  # -------------------------------------------
+
+  class << self
+    attr_accessor :configuration
+
+    ALGORITHM = 'RS256'
+    ISSUER_BASE_URL = 'https://securetoken.google.com/'
+    CLIENT_CERT_URL = 'https://www.googleapis.com/robot/v1/metadata/x509/securetoken@system.gserviceaccount.com'
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def verify(token)
+      raise 'id token must be a String' unless token.is_a?(String)
+
+      full_decoded_token = decode_token(token)
+
+      err_msg = validate_jwt(full_decoded_token)
+      raise err_msg if err_msg
+
+      public_key = fetch_public_keys[full_decoded_token[:header]['kid']]
+      unless public_key
+        raise 'Firebase ID token has "kid" claim which does not correspond to ' +
+          'a known public key. Most likely the ID token is expired, so get a fresh token from your client ' +
+          'app and try again.'
+      end
+
+      certificate = OpenSSL::X509::Certificate.new(public_key)
+      decoded_token = decode_token(token, certificate.public_key, true, { algorithm: ALGORITHM, verify_iat: true })
+
+      {
+        'uid' => decoded_token[:payload]['sub'],
+        'decoded_token' => decoded_token
+      }
+    end
+
+
+    private
+
+      def decode_token(token, key=nil, verify=false, options={})
+        begin
+          decoded_token = JWT.decode(token, key, verify, options)
+        rescue JWT::ExpiredSignature => e
+          raise 'Firebase ID token has expired. Get a fresh token from your client app and try again.'
+        rescue => e
+          raise "Firebase ID token has invalid signature. #{e.message}"
+        end
+
+        {
+          payload: decoded_token[0],
+          header: decoded_token[1]
+        }
+      end
+
+      def fetch_public_keys
+        cache_path = configuration.cache_path
+        cache_time = configuration.cache_time
+        data = nil
+        begin
+          # Fetch from cache if within an hour (UTC timezone)
+          s = File.stat(cache_path)
+          File.delete(cache_path) if (Time.now.utc - s.mtime.utc) > cache_time
+          data = JSON.parse(open(cache_path).read)
+        rescue => error
+          puts "#{error.message}: Fetching public key from Google..."
+
+          # Fetch keys from Google if no cache or after an hour
+          uri = URI.parse(CLIENT_CERT_URL)
+          https = Net::HTTP.new(uri.host, uri.port)
+          https.use_ssl = true
+
+          res = https.start {
+            https.get(uri.request_uri)
+          }
+          json_string = res.body
+          data = JSON.parse(json_string)
+
+          if (data['error']) then
+            msg = 'Error fetching public keys for Google certs: ' + data['error']
+            msg += " (#{res['error_description']})" if (data['error_description'])
+            raise msg
+          else
+            save_cache_file(json_string)
+          end
+        end
+        data
+      end
+
+      def save_cache_file(json_string)
+        cache_path = configuration.cache_path
+        dirname = File.dirname(cache_path)
+        unless File.directory?(dirname)
+          puts "Creating a directory: #{dirname}"
+          FileUtils.mkdir_p(dirname)
+        end
+        open cache_path, 'w' do |io|
+          io.write json_string
+        end
+      end
+
+      def validate_jwt(json)
+        project_id = configuration.project_id
+        raise 'You need to set Firebase project ID' unless project_id
+
+        payload = json[:payload]
+        header = json[:header]
+
+        return 'Firebase ID token has no "kid" claim.' unless header['kid']
+        return "Firebase ID token has incorrect algorithm. Expected \"#{ALGORITHM}\" but got \"#{header['alg']}\"." unless header['alg'] == ALGORITHM
+        return "Firebase ID token has incorrect \"aud\" (audience) claim. Expected \"#{project_id}\" but got \"#{payload['aud']}\"." unless payload['aud'] == project_id
+
+        issuer = ISSUER_BASE_URL + project_id
+        return "Firebase ID token has incorrect \"iss\" (issuer) claim. Expected \"#{issuer}\" but got \"#{payload['iss']}\"."  unless payload['iss'] == issuer
+
+        return 'Firebase ID token has no "sub" (subject) claim.' unless payload['sub'].is_a?(String)
+        return 'Firebase ID token has an empty string "sub" (subject) claim.'  if payload['sub'].empty?
+        return 'Firebase ID token has "sub" (subject) claim longer than 128 characters.' if payload['sub'].size > 128
+
+        nil
+      end
+
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: firebase_idtoken
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- shunwitter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Retrieved UID on server side using ID token sent from client
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase_idtoken.gemspec
+- lib/firebase_idtoken.rb
+- lib/firebase_idtoken/configuration.rb
+- lib/firebase_idtoken/version.rb
+homepage: https://github.com/shunwitter/firebase_idtoken
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby implementation to verify Google firebase ID token
+test_files: []