google-auth-token_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c85cade77aab2f374eac0dff1223b436a149202
+  data.tar.gz: c7b99dd26296a90cffb992a955a302511ac9427d
+SHA512:
+  metadata.gz: 1d8b6992a81e86cb64a17d1bbb037e7199ac4810813ee15f1d53478475c1808c04875d55e7a81144b41e62d47c944acde50430886c8f75497e3275974976dc98
+  data.tar.gz: cc20fbe4694191a04a6d5ad86b9b7ddfe44e02161ecfd96d1dd3b06b025e5fcff147fb69394fd94fe59f8b34750a9d628d3aebe8b9ee50d30438d0f748443588

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.15.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 - September 17, 2017
+
+- initial implementation

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    google-auth-token_validator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dotenv (2.2.1)
+    json (2.1.0)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.15.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  coveralls (~> 0.8)
+  dotenv (~> 2.2)
+  google-auth-token_validator!
+  pry (~> 0.10)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Hamza Tayeb
+
+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,68 @@
+# Google Auth Token Validator
+
+[![Build Status](https://travis-ci.org/hamza/google-auth-token-validator-ruby.svg?branch=master)](https://travis-ci.org/hamza/google-auth-token-validator-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/hamza/google-auth-token-validator-ruby/badge.svg?branch=master)](https://coveralls.io/github/hamza/google-auth-token-validator-ruby?branch=master)
+
+The Google Sign-In API gives OAuth2 JSON Web Tokens (JWT) as response data upon user sign-in. A necessary step for a service provider to trust such a token involves validating the token, rather than simply trusting the token, which would allow a malicious client to simply assert itself.
+
+Google provides libraries in several languages (https://goo.gl/jkzS18) to serve this function, as well as an API endpoint that can outsource the task to Google's own servers (thereby introducing an additional network round trip into every authentication step), but a Ruby implementation is missing. This gem fills that gap.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-auth-token_validator' # doesn't work yet! stay tuned …
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-auth-token_validator
+
+## Usage
+
+```ruby
+require "googleauth/token_validator"
+
+client_id = "<your client ID>"
+id_token = "<user's ID token>"
+
+begin
+  valid = Google::Auth::TokenValidator.new(id_token, client_id).validate
+rescue Google::Auth::TokenValidator::Error => e
+  puts e.message
+  valid = false
+end
+
+if valid
+  # trust this token
+end
+```
+
+## 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.
+
+This gem uses [`dotenv`](https://github.com/bkeepers/dotenv) to set up the test environment. To enable local testing, you'll need to set up the following -
+
+|Key|Description|
+|---|---|
+|`TEST_CLIENT_ID`|A Google OAuth client ID, used to compare ID tokens against|
+|`TEST_CLIENT_SECRET`|A Google OAuth client secret, used to authorize token refreshes|
+|`REFRESH_TOKEN`|A refresh token for a test user. It is recommended to use the [Google OAuth Playground](https://developers.google.com/oauthplayground/) to generate one|
+
+**NOTE**: it is not recommended to use your real account for this. Instead use a test user.
+
+Use the [Google Cloud Console](https://console.cloud.google.com) to set up an OAuth id/secret pair for use with testing.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [the repo](https://github.com/hamza/google_signin_token_validator).
+
+## 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 "googleauth/token_validator"
+
+# 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/google-auth_token_validator.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "googleauth/token_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-auth-token_validator"
+  spec.version       = Google::Auth::TokenValidator::VERSION
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ["Hamza Tayeb"]
+  spec.email         = ["hamza.tayeb@gmail.com"]
+
+  spec.summary       = "Ruby gem to validate signed JSON Web Tokens from Google's sign-in API"
+  spec.description   = <<-DESC
+    The Google Sign-In API gives OAuth2 JSON Web Tokens (JWT) as response data upon user sign-in.
+    A necessary step for a service provider to trust such a token involves validating the token,
+    rather than simply trusting the token, which would allow a malicious client to simply assert
+    itself.
+
+    Google provides libraries in several languages (https://goo.gl/jkzS18) to serve this function,
+    as well as an API endpoint that can outsource the task to Google's own servers (thereby
+    introducing an additional network round trip into every authentication step), but a Ruby
+    implementation is missing. This gem fills that gap.
+  DESC
+
+  spec.homepage      = "https://github.com/hamza/google-signin-token-validator"
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "dotenv", "~> 2.2"
+end

data/lib/googleauth/token_validator.rb

@@ -0,0 +1,87 @@
+require "net/http"
+require "json"
+require "base64"
+require "openssl"
+
+class Google::Auth::TokenValidator
+  GOOGLE_SIGNON_CERTS_URL    = "https://www.googleapis.com/oauth2/v1/certs".freeze
+  ISSUERS                    = %w(accounts.google.com https://accounts.google.com).freeze
+  CLOCK_SKEW_SECONDS         = 300 # five minutes
+  MAX_TOKEN_LIFETIME_SECONDS = 86400 # one day
+
+  attr_reader :signed, :signature, :envelope, :payload, :client_id
+
+  def initialize jwt, client_id
+    segments = jwt.split(".")
+
+    fail Error, "Wrong number of segments in token: #{jwt}" unless segments.size.eql? 3
+
+    @client_id = client_id
+
+    @signed = "#{segments[0]}.#{segments[1]}"
+    @signature = segments[2]
+
+    @envelope = JSON.parse Base64.decode64(segments[0])
+    @payload = JSON.parse Base64.decode64(segments[1])
+  end
+
+  def validate max_expiry = MAX_TOKEN_LIFETIME_SECONDS
+    unless [@signed, @signature, @envelope, @payload].all?
+      fail Error, "Validator was not properly initialized"
+    end
+
+    unless self.class._certs.keys.include? @envelope["kid"]
+      fail Error, "No matching Google cert found for envelope: #{@envelope}"
+    end
+
+    pem = self.class._certs[envelope["kid"]]
+    cert = OpenSSL::X509::Certificate.new pem
+    digest = OpenSSL::Digest::SHA256.new
+
+    verified = cert.public_key.verify(digest, Base64.urlsafe_decode64(@signature), @signed)
+
+    fail Error, "Token signature invalid" unless verified
+
+    fail Error, "No issue time in token" if @payload["iat"].to_s.empty?
+    fail Error, "No expiration time in token" if @payload["exp"].to_s.empty?
+
+    now      = Time.now.to_i
+    earliest = @payload["iat"] - CLOCK_SKEW_SECONDS
+    latest   = @payload["exp"] + CLOCK_SKEW_SECONDS
+
+    fail Error, "Expiration time too far in future" if @payload["exp"] >= Time.now.to_i + max_expiry
+    fail Error, "Token used too early" if now < earliest
+    fail Error, "Token used too late" if now > latest
+
+    unless ISSUERS.include? @payload["iss"]
+      fail Error, "Invalid issuer. Expected one of #{ISSUERS}, but got #{@payload["iss"]}"
+    end
+
+    if @client_id.is_a? Array
+      aud_verified = @client_id.include?(@payload["aud"])
+    elsif @client_id.is_a? String
+      aud_verified = @payload["aud"] == @client_id
+    else
+      fail Error, "Invalid client id(s)"
+    end
+
+    unless aud_verified
+      fail Error, "Wrong recipient - payload audience doesn't match required audience"
+    end
+
+    return true
+  end
+
+  class << self
+    attr_accessor :_cached_certs
+
+    def _certs
+      @_cached_certs ||= begin
+        uri = URI(GOOGLE_SIGNON_CERTS_URL)
+        JSON.parse Net::HTTP.get(uri)
+      end
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/googleauth/token_validator/version.rb

@@ -0,0 +1,7 @@
+module Google
+  module Auth
+    class TokenValidator
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: google-auth-token_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hamza Tayeb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: |2
+      The Google Sign-In API gives OAuth2 JSON Web Tokens (JWT) as response data upon user sign-in.
+      A necessary step for a service provider to trust such a token involves validating the token,
+      rather than simply trusting the token, which would allow a malicious client to simply assert
+      itself.
+
+      Google provides libraries in several languages (https://goo.gl/jkzS18) to serve this function,
+      as well as an API endpoint that can outsource the task to Google's own servers (thereby
+      introducing an additional network round trip into every authentication step), but a Ruby
+      implementation is missing. This gem fills that gap.
+email:
+- hamza.tayeb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google-auth_token_validator.gemspec
+- lib/googleauth/token_validator.rb
+- lib/googleauth/token_validator/version.rb
+homepage: https://github.com/hamza/google-signin-token-validator
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby gem to validate signed JSON Web Tokens from Google's sign-in API
+test_files: []