firebase_auth_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e67c7096cdd959d57fe0018262f5d9eacc8b60d7af65f86d76376ee973f4a440
+  data.tar.gz: f840ca046b42ae6573c68be346bce03fcd6ac9bc27b805b046af1b238d6cfe82
+SHA512:
+  metadata.gz: a003c3c879ae030ff20bfdc43cd764c211b263f5dce6abbec112708aaccb323676a3d4d92fa11fa76305d583e82a5c6cfb78a15ec19edbf95429610f512ff482
+  data.tar.gz: 669413ca5ddf990aaa21e1490c0dda6e80a73c7cda40dc62992db9fb0af4d02a088e2f17e5efcbfbac3db5ce5b19c07fd94df817059b829fe48c78d1e15e85aa

data/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: ci
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1 @@
+noop

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yukito Ito
+
+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,39 @@
+# FirebaseAuthRuby
+
+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_ruby`. 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_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebase_auth_ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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_ruby.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "firebase_auth_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebase_auth_ruby"
+  spec.version       = FirebaseAuthRuby::VERSION
+  spec.authors       = ["Yukito Ito"]
+  spec.email         = ["yukibukiyou@gmail.com"]
+
+  spec.summary       = %q{Firebase Auth with Ruby}
+  spec.description   = %q{Verify ID Token}
+  spec.homepage      = "https://github.com/ykpythemind/firebase_auth_ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ykpythemind/firebase_auth_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/ykpythemind/firebase_auth_ruby/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_dependency "jwt", ">= 2.2"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/firebase_auth_ruby.rb

@@ -0,0 +1,17 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require "jwt"
+
+module FirebaseAuthRuby
+  class Error < StandardError; end
+
+  mattr_accessor :cache_store
+end
+
+require "firebase_auth_ruby/version"
+
+require "firebase_auth_ruby/util"
+require "firebase_auth_ruby/public_key_fetcher"
+
+require "firebase_auth_ruby/verifier/base"
+require "firebase_auth_ruby/verifier/id_token_verifier"
+require "firebase_auth_ruby/verifier/cookie_session_verifier"

data/lib/firebase_auth_ruby/public_key_fetcher.rb

@@ -0,0 +1,60 @@
+require "forwardable"
+require 'json'
+require 'net/http'
+require 'uri'
+
+module FirebaseAuthRuby
+  class PublicKeyFetcher
+    extend Forwardable
+
+    def_delegator ::FirebaseAuthRuby, :cache_store
+    def_delegators :cache_store, :read, :write
+
+    def initialize
+      @cache_hit = false
+    end
+
+    def fetch(url)
+      @cache_hit = false
+
+      public_keys = read(public_keys_cache_key(url))
+      public_keys_expire_at = read(expire_at_cache_key(url))
+
+      public_keys_still_valid = public_keys && public_keys_expire_at && Time.now.to_i < public_keys_expire_at.to_i
+
+      if public_keys_still_valid
+        @cache_hit = true
+        return public_keys
+      end
+
+      res = Util.get!(url)
+
+      cache_control_header = res['cache-control']
+      if cache_control_header
+        parts = cache_control_header.split(',')
+        parts.each { |part|
+          subpart = part.strip.split('=')
+          if subpart[0] == 'max-age'
+            max_age = subpart[1].to_i
+            write(expire_at_cache_key(url), Time.now.to_i + (max_age * 1000))
+          end
+        }
+      end
+
+      public_keys = JSON.parse(res.body)
+      write(public_keys_cache_key(url), public_keys)
+
+      public_keys
+    end
+
+    private
+
+    def public_keys_cache_key(url)
+      "firebase_auth_ruby/public_keys/#{url}"
+    end
+
+    def expire_at_cache_key(url)
+      "firebase_auth_ruby/public_keys_expire_at/#{url}"
+    end
+  end
+end

data/lib/firebase_auth_ruby/util.rb

@@ -0,0 +1,16 @@
+require 'net/https'
+
+module FirebaseAuthRuby
+  module Util
+    def self.get!(url)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, 443)
+      http.use_ssl = true
+
+      res = http.get(uri.path)
+      raise Error unless res.is_a? Net::HTTPSuccess
+
+      res
+    end
+  end
+end

data/lib/firebase_auth_ruby/verifier/base.rb

@@ -0,0 +1,69 @@
+
+module FirebaseAuthRuby::Verifier
+  class Base
+    def self.verify!(token:, project_id:, public_key_fetcher: PublicKeyFetcher.new)
+      new(
+        token: token,
+        project_id: project_id,
+        public_key_fetcher: public_key_fetcher
+      ).verify!
+    end
+
+    def initialize(token:, project_id:, public_key_fetcher:)
+      @token = token
+      @project_id = project_id
+      @public_key_fetcher = public_key_fetcher
+    end
+
+    def verify!
+      public_key = fetch_and_check_public_key!
+
+      decode_with_pubkey!(public_key)
+    end
+
+    private
+
+    attr_reader :token, :project_id, :public_key_fetcher
+
+    def fetch_and_check_public_key!
+      public_keys = public_key_fetcher.fetch(public_key_url)
+
+      decoded =
+        JWT.decode token,
+                    nil,
+                    false,
+                    verify_iat: true,
+                    verify_aud: true, aud: project_id,
+                    verify_iss: true, iss: iss
+
+      headers = decoded[1]
+      kid = headers['kid'] || raise(Error, %("kid" not found in JWT header))
+
+      raise Error, %("kid" claim does not correspond to a known public key.) unless public_keys.key?(kid)
+
+      public_keys[kid]
+    end
+
+    def decode_with_pubkey!(public_key)
+      cert = OpenSSL::X509::Certificate.new(public_key)
+      decoded =
+        JWT.decode token,
+                   cert.public_key,
+                   true,
+                   algorithm: 'RS256',
+                   iss: iss, verify_iss: true,
+                   aud: project_id, verify_aud: true,
+                   verify_iat: true
+
+      decoded[0]
+    end
+
+    def iss
+      raise NotImplementedError
+    end
+
+    def public_key_url
+      raise NotImplementedError
+    end
+  end
+end

data/lib/firebase_auth_ruby/verifier/cookie_session_verifier.rb

@@ -0,0 +1,15 @@
+module FirebaseAuthRuby::Verifier
+  class CookieSessionVerifier < Base
+    # https://firebase.google.com/docs/auth/admin/manage-cookies#verify_session_cookie_and_check_permissions
+
+    private
+
+    def iss
+      "https://session.firebase.google.com/#{project_id}"
+    end
+
+    def public_key_url
+      "https://www.googleapis.com/identitytoolkit/v3/relyingparty/publicKeys"
+    end
+  end
+end

data/lib/firebase_auth_ruby/verifier/id_token_verifier.rb

@@ -0,0 +1,15 @@
+module FirebaseAuthRuby::Verifier
+  class IdTokenVerifier < Base
+    # https://firebase.google.com/docs/auth/admin/verify-id-tokens
+
+    private
+
+    def iss
+      "https://securetoken.google.com/#{project_id}"
+    end
+
+    def public_key_url
+      "https://www.googleapis.com/robot/v1/metadata/x509/securetoken@system.gserviceaccount.com"
+    end
+  end
+end

data/lib/firebase_auth_ruby/version.rb

@@ -0,0 +1,3 @@
+module FirebaseAuthRuby
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: firebase_auth_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yukito Ito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-28 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Verify ID Token
+email:
+- yukibukiyou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase_auth_ruby.gemspec
+- lib/firebase_auth_ruby.rb
+- lib/firebase_auth_ruby/public_key_fetcher.rb
+- lib/firebase_auth_ruby/util.rb
+- lib/firebase_auth_ruby/verifier/base.rb
+- lib/firebase_auth_ruby/verifier/cookie_session_verifier.rb
+- lib/firebase_auth_ruby/verifier/id_token_verifier.rb
+- lib/firebase_auth_ruby/version.rb
+homepage: https://github.com/ykpythemind/firebase_auth_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ykpythemind/firebase_auth_ruby
+  source_code_uri: https://github.com/ykpythemind/firebase_auth_ruby
+  changelog_uri: https://github.com/ykpythemind/firebase_auth_ruby/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Firebase Auth with Ruby
+test_files: []