firebase-auth-id_token_keeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cebc3f86726a5e16d9b55886aef8f4a791e9f9764284d969dce650a0edcc685
+  data.tar.gz: 7bcd67ba7a9a09d5c4f9d6fa3452fe7c0fedb4757e2d76ff11501ac4d701df73
+SHA512:
+  metadata.gz: d67cb27cdac0cc329b3e319a97a4805c4843f18930ecf9c25092ffb061d061fdbd3c6f08b6072acaf2dd2e2d9716d4c13a4859194ac8c17848bcc91848f98787
+  data.tar.gz: ddcb295e7142536df1d6898dd42d95a1963d387ce9b2f7123a2ff9a6280276b040d946d30318ffbd707a02a1d68fa6f8a1df2d56cbf88d7c2eff1a9566651990

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 deraru@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in firebase-auth-id_token_keeper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    firebase-auth-id_token_keeper (0.1.0)
+      activesupport (>= 5.1.0)
+      jwt (>= 1.5.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    jwt (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  firebase-auth-id_token_keeper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rui Onodera
+
+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,43 @@
+# Firebase::Auth::IDTokenKeeper
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/firebase/auth/id_token_keeper`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firebase-auth-id_token_keeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebase-auth-id_token_keeper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/firebase-auth-id_token_keeper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Firebase::Auth::IDTokenKeeper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/firebase-auth-id_token_keeper/blob/master/CODE_OF_CONDUCT.md).

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_keeper"
+
+# 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_keeper.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebase/auth/id_token_keeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'firebase-auth-id_token_keeper'
+  spec.version       = Firebase::Auth::IDTokenKeeper::VERSION
+  spec.authors       = ['Rui Onodera']
+  spec.email         = ['deraru@gmail.com']
+
+  spec.summary       = 'Verify the Firebase ID Token which obtained at the client side.'
+  spec.description   = 'Firebase Authentication uses ID Token. This gem verify the token on the server side.'
+  spec.homepage      = 'https://github.com/Findy/firebase-auth-id_token_keeper'
+  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_dependency 'jwt', '>= 1.5.6'
+  spec.add_dependency 'activesupport', '>= 5.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Firebase
+  module Auth
+    module IDTokenKeeper
+      class Config
+        attr_accessor :firebase_project_id
+
+        def initialize
+          self.firebase_project_id = DEFAULT_FIREBASE_PROJECT_ID
+        end
+
+        private
+
+        DEFAULT_FIREBASE_PROJECT_ID = 'default_firebase_project_id'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+require 'jwt'
+
+module Firebase
+  module Auth
+    module IDTokenKeeper
+      class IDToken
+        attr_accessor :encoded_jwt
+
+        FIREBASE_ALGORITHM = 'RS256'
+
+        def initialize(encoded_jwt)
+          self.encoded_jwt = encoded_jwt
+        end
+
+        def verified_id_token
+          decoded_jwt if verify!
+        end
+
+        private
+
+        def verify!
+          verify_header && verify_payload && verify_signature
+        end
+
+        def verify_header
+          # Algorithm must be match Firebase algorithm.
+          raise 'Invalid alg in ID Token header.' if jwt_header['alg'] != FIREBASE_ALGORITHM
+
+          # Key ID must be listed at public keys endpoint.
+          raise 'Invalid kid in ID Token header.' unless public_keys_endpoint.exist_public_key_by?(kid: jwt_header['kid'])
+
+          true
+        end
+
+        def verify_payload
+          # Expiration time must be in the future.
+          raise 'Invalid exp in payload.' if jwt_payload['exp'] < Time.now.to_i
+
+          # Issued-at time must be in the past.
+          raise 'Invalid iat in payload.' if Time.now.to_i < jwt_payload['iat']
+
+          # Audience must be match Firebase project ID.
+          raise 'Invalid aud in payload.' if jwt_payload['aud'] != IDTokenKeeper.config.firebase_project_id
+
+          # Issuer must be match Firebase issuer URI.
+          raise 'Invalid iss in payload.' if jwt_payload['iss'] != FIREBASE_ISSUER_URI
+
+          # Subject must be a non-empty string.
+          raise 'Invalid sub in payload.' if jwt_payload['sub'].strip.empty?
+
+          # Authentication time must be in the past.
+          raise 'Invalid auth_time in payload.' if Time.now.to_i < jwt_payload['auth_time']
+
+          true
+        end
+
+        def verify_signature
+          JWT.decode(encoded_jwt, certification.public_key, true, { algorithm: FIREBASE_ALGORITHM, verify_iat: true })
+
+          true
+        rescue JWT::ExpiredSignature => e
+          raise 'Signature has expired.'
+        end
+
+        def certification
+          public_keys_endpoint.find_certificate_by(kid: jwt_header['kid'])
+        end
+
+        def public_keys_endpoint
+          @public_keys_endpoint ||= PublicKeysEndpoint.new
+        end
+
+        def decoded_jwt
+          @decoded_jwt ||= JWT.decode(encoded_jwt, nil, false, { algorithm: FIREBASE_ALGORITHM })
+        end
+
+        def jwt_header
+          decoded_jwt[1]
+        end
+
+        def jwt_payload
+          decoded_jwt[0]
+        end
+
+        private
+
+        def firebase_issuer_uri
+          "https://securetoken.google.com/#{IDTokenKeeper.config.firebase_project_id}"
+        end
+      end
+    end
+  end
+end

data/lib/firebase/auth/id_token_keeper/public_keys_endpoint.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'json'
+require 'open-uri'
+
+module Firebase
+  module Auth
+    module IDTokenKeeper
+      class PublicKeysEndpoint
+        PUBLIC_KEYS_URI = 'https://www.googleapis.com/robot/v1/metadata/x509/securetoken@system.gserviceaccount.com'
+
+        def find_public_key_by(kid:)
+          public_keys[kid]
+        end
+
+        def find_certificate_by(kid:)
+          OpenSSL::X509::Certificate.new(public_keys[kid]) if exist_public_key_by?(kid: kid)
+
+        end
+
+        def exist_public_key_by?(kid:)
+          public_keys.has_key?(kid)
+        end
+
+        def public_keys
+          @public_keys ||= if response_status == 200
+                              JSON.parse(response_body)
+                            else
+                              []
+                            end
+        end
+
+        def response_body
+          @response_body ||= response.read
+        end
+
+        def response_status
+          @response_status ||= response.status[0].to_i
+        end
+
+        def response
+          @response ||= open(PUBLIC_KEYS_URI)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Firebase
+  module Auth
+    module IDTokenKeeper
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/firebase/auth/id_token_keeper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Firebase
+  module Auth
+    module IDTokenKeeper
+
+       class << self
+        def configure
+          yield config
+        end
+
+        def config
+          @config ||= Config.new
+        end
+      end
+    end
+  end
+end
+
+require 'firebase/auth/id_token_keeper/version'
+require 'firebase/auth/id_token_keeper/config'
+require 'firebase/auth/id_token_keeper/public_keys_endpoint'
+require 'firebase/auth/id_token_keeper/id_token'

data/lib/generators/firebase/auth/id_token_keeper/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Firebase
+  module Auth
+    module IDTokenKeeper
+      module Generators
+        class InstallGenerator < Rails::Generators::Base
+          source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+          namespace 'firebase:auth:id_token_keeper:install'
+
+          def copy_config_file
+            template 'firebase_auth_id_token_keeper.rb', 'config/initializers/firebase_auth_id_token_keeper.rb'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/firebase/auth/id_token_keeper/templates/firebase_auth_id_token_keeper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Firebase::Auth::IDTokenKeeper.configure do |config|
+  # config.firebase_project_id = 'project_id'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: firebase-auth-id_token_keeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rui Onodera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-15 00:00:00.000000000 Z
+dependencies:
+- !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
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !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'
+- !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'
+description: Firebase Authentication uses ID Token. This gem verify the token on the
+  server side.
+email:
+- deraru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase-auth-id_token_keeper.gemspec
+- lib/firebase/auth/id_token_keeper.rb
+- lib/firebase/auth/id_token_keeper/config.rb
+- lib/firebase/auth/id_token_keeper/id_token.rb
+- lib/firebase/auth/id_token_keeper/public_keys_endpoint.rb
+- lib/firebase/auth/id_token_keeper/version.rb
+- lib/generators/firebase/auth/id_token_keeper/install_generator.rb
+- lib/generators/firebase/auth/id_token_keeper/templates/firebase_auth_id_token_keeper.rb
+homepage: https://github.com/Findy/firebase-auth-id_token_keeper
+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.3
+signing_key: 
+specification_version: 4
+summary: Verify the Firebase ID Token which obtained at the client side.
+test_files: []