ms-id-token-validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ca3f629dd20506004d630d41dcce5d4ec5018df
+  data.tar.gz: f3659bc2b9d880e4bfbc0cd373ef39c65c9d0ac4
+SHA512:
+  metadata.gz: ec2d3ea4a273a319f3e1673bd9e5544c6ce1ef664c205edc31311cbad2a7d46db6ad434256bc3a357a5d73a9c44fa55b2702234a16f74c7c9a9b1a9115cf9a1a
+  data.tar.gz: c41caeb2785fac8e38c70038df5f55c7fa581f777c0024dbbbee093dc23824923717ecec7dd8212c269a17dfd2bb1bc8b3132bbc8c5c716e2b4352ee3e42ec4f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# 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.2.4
+before_install: gem install bundler -v 1.15.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 ms-id-token-validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 QQ
+
+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,62 @@
+# MsIdTokenValidator
+
+This library is provided to validate id token from Microsoft Oauth2.
+
+Inspired from the [Google ID Token](https://github.com/google/google-id-token)
+
+### Disclaimer
+I am entirely not affiliated with Microsoft, the code is provided as-is and no warranty.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ms-id-token-validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ms-id-token-validator
+
+## Usage
+    
+```ruby
+validator = MsIdToken::Validator.new
+
+begin
+  # audience is possibly the Application Client ID
+  payload = validator.check(id_token, audience)
+rescue MsIdToken::IdTokenExpired => ex
+  puts 'Id token is expired'
+end
+
+```
+
+## References
+
+[Certificate credentials for application authentication](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials)
+
+[Validate an Exchange identity token](https://docs.microsoft.com/en-us/outlook/add-ins/validate-an-identity-token)
+
+[Azure Active Directory v2.0 tokens reference](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-tokens)
+
+[Azure AD token reference](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-token-and-claims)
+
+## 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/quangquach/ms-id-token-validator. 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](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 "ms-id-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/lib/ms-id-token-validator/version.rb

@@ -0,0 +1,5 @@
+module MsIdToken
+  class Validator
+    VERSION = "0.1.0"
+  end
+end

data/lib/ms-id-token-validator.rb

@@ -0,0 +1,108 @@
+require 'net/http'
+require 'json/jwt'
+
+module MsIdToken
+  class BadIdTokenFormat < StandardError; end
+  class BadIdTokenHeaderFormat < StandardError; end
+  class BadIdTokenPayloadFormat < StandardError; end
+  class UnableToFetchMsConfig < StandardError; end
+  class UnableToFetchMsCerts < StandardError; end
+  class BadPublicKeysFormat < StandardError; end
+  class UnableToFindMsCertsUri < StandardError; end
+  class InvalidAudience < StandardError; end
+  class IdTokenExpired < StandardError; end
+  class IdTokenNotYetValid < StandardError; end
+
+  class Validator
+    MS_CONFIG_URI = 'https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration'.freeze
+    CACHED_CERTS_EXPIRY = 3600
+    TOKEN_TYPE = 'JWT'.freeze
+    TOKEN_ALGORITHM = 'RS256'.freeze
+
+    def initialize(options={})
+      @cached_certs_expiry = options.fetch(:expiry, CACHED_CERTS_EXPIRY)
+    end
+
+    def check(id_token, audience)
+      encoded_header, encoded_payload, signature = id_token.split('.')
+
+      raise BadIdTokenFormat if encoded_payload.nil? || signature.nil?
+
+      header = JSON.parse(Base64.decode64(encoded_header), symbolize_names: true)
+
+      public_keys = JSON::JWK::Set.new(ms_public_keys)
+
+      payload = JSON::JWT.decode(id_token, public_keys).symbolize_keys
+
+      verify_payload(payload, audience)
+
+      payload
+    end
+
+    private
+
+    def verify_header(header)
+      valid_header = header[:typ] == TOKEN_TYPE && header[:alg] == TOKEN_ALGORITHM
+
+      valid_header &= !(header[:kid].nil? && header[:x5t].nil?)
+
+      raise BadIdTokenHeaderFormat unless valid_header
+    end
+
+    def verify_payload(payload, audience)
+      if payload[:aud].nil? ||
+         payload[:exp].nil? ||
+         payload[:nbf].nil? ||
+         payload[:sub].nil? ||
+         payload[:iss].nil? ||
+         payload[:iat].nil? ||
+         payload[:tid].nil? ||
+         payload[:iss].match(/https:\/\/login\.microsoftonline\.com\/(.+)\/v2\.0/).nil?
+        raise BadIdTokenPayloadFormat
+      end
+
+      raise InvalidAudience if payload[:aud] != audience
+
+      current_time = Time.current.to_i
+
+      raise IdTokenExpired if payload[:exp] < current_time
+
+      raise IdTokenNotYetValid if payload[:nbf] > current_time
+    end
+
+    def ms_public_keys
+      if @ms_public_keys.nil? || cached_certs_expired?
+        @ms_public_keys = fetch_public_keys
+        @last_cached_at = Time.current.to_i
+      end
+
+      @ms_public_keys
+    end
+
+    def fetch_public_keys
+      ms_certs_uri = fetch_ms_config[:jwks_uri]
+
+      raise UnableToFindMsCertsUri if ms_certs_uri.nil?
+
+      uri = URI(ms_certs_uri)
+      response = Net::HTTP.get_response(uri)
+
+      raise UnableToFetchMsConfig unless response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    def fetch_ms_config
+      uri = URI(MS_CONFIG_URI)
+      response = Net::HTTP.get_response(uri)
+
+      raise UnableToFetchMsConfig unless response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    def cached_certs_expired?
+      !(@last_cached_at.is_a?(Integer) && @last_cached_at + @cached_certs_expiry >= Time.current.to_i)
+    end
+  end
+end

data/ms-id-token-validator.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ms-id-token-validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ms-id-token-validator"
+  spec.version       = MsIdToken::Validator::VERSION
+  spec.authors       = ["QQ"]
+  spec.email         = ["me@quang.be"]
+
+  spec.summary       = %q{Validate the Microsoft Oauth2 ID token}
+  spec.description   = %q{Validate the id token from Microsoft oauth2 service}
+  spec.homepage      = "https://github.com/quangquach/ms-id-token-validator"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_runtime_dependency('json-jwt', '~> 1.7')
+
+  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('pry', '~> 0')
+  spec.add_development_dependency('pry-doc', '~> 0')
+  spec.add_development_dependency('timecop', '~> 0')
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: ms-id-token-validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- QQ
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validate the id token from Microsoft oauth2 service
+email:
+- me@quang.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ms-id-token-validator.rb
+- lib/ms-id-token-validator/version.rb
+- ms-id-token-validator.gemspec
+homepage: https://github.com/quangquach/ms-id-token-validator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Validate the Microsoft Oauth2 ID token
+test_files: []