easyship-doorkeeper-jwt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2b423dfa40ffd4acc4694de503b46886c2d4f04
+  data.tar.gz: 57c6b431d288f663f06da460309e3cfff31e3bf9
+SHA512:
+  metadata.gz: 62f5518b923d5f375c547e4d92b693f9db166251591d204f1f7c8a49bddd1863f42d4e1024cf25460cf5c6c8b5c5c6d809d97329981450c151551fd5d9d82dc4
+  data.tar.gz: 584d82408f354d40e302b3adabe9fcceb3b67b95207ac82957814e54b23712f2149fb98d7707ef8990b1e8141851c891f93c2b71a483e066dec803dec5a8949f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Omac, Aloha
+
+MIT License
+
+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,90 @@
+# Doorkeeper JWT Assertion
+
+Extending [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) to support JWT Assertion grant type using a **secret** or a **private key file** or **application's public key**.
+
+**This library is in alpha. Future incompatible changes may be necessary.**
+
+## Install
+
+Add the gem to the Gemfile
+
+```ruby
+gem 'easyship-doorkeeper-jwt', require: 'doorkeeper/jwt_assertion'
+```
+
+## Configuration
+
+Inside your doorkeeper configuration file add the one of the following:
+
+``` ruby
+Doorkeeper.configure do
+
+  # enable jwt handler
+  jwt_enable true
+
+  jwt_private_key Rails.root.join('config', 'keys', 'private.key')
+
+  jwt_secret 'notasecret'
+
+  # Optional
+  jwt_use_issuer_as_client_id true
+
+  # using public key as decode key
+  jwt_use_application_public_key_as_key true
+
+end
+```
+
+This will automatically push `assertion` into the Doorkeeper's grant_types configuration attribute.
+
+When `jwt_use_issuer_as_client_id` is set to false then the `client_id` MUST be available from the parameters. By default it will extract the 'iss' and use it as the client_id to retrieve the oauth application.
+
+Use the `resource_owner_authenticator` in the configuration to identify the owner based on the JWT claim values. This values can be accessible from `jwt`.
+
+**by default it setup application's owner as owner.**
+
+If the client request a token with an invalid assertion, or an expired JWT claim, an :invalid_grant error response will be generated before retrieving the resource_owner.
+
+``` ruby
+Doorkeeper.configure do
+
+  resource_owner_authenticator do
+
+    if jwt
+      jwt['sub'].present? and User.find_by_email(jwt['sub'])
+    end
+
+  end
+
+end
+
+```
+
+## Client Usage
+
+Generate an assertion request token using a private key file or a secret:
+
+``` ruby
+client = OAuth2::Client.new('client_id', 'client_secret', :site => 'http://my-site.com')
+
+p12 = OpenSSL::PKCS12.new( Rails.root.join('config', 'keys', 'private.p12').open )
+
+params = { :aud => 'audience',
+           :sub => 'client_id',
+           :iss => 'client_id',
+           :scope => 'scope',
+           :exp => Time.now.utc.to_i + 5.minutes }
+
+token = client.assertion.get_token(params)
+```
+
+>  "[...] refresh tokens are not issued
+>  in response to assertion grant requests and access tokens will be
+>  issued with a reasonably short lifetime."
+> - [draft-ietf-oauth-assertions-18](https://tools.ietf.org/html/draft-ietf-oauth-assertions-18#section-4.1)
+
+## TO DO
+
+* Better error handling
+* JWT Client Authentication Flow
+* Testing

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/easyship-doorkeeper-jwt.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doorkeeper/jwt_assertion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'easyship-doorkeeper-jwt'
+  spec.version       = Doorkeeper::JwtAssertion::VERSION
+  spec.authors       = ['AlohaCC']
+  spec.email         = ['y.alohac@gmail.com']
+  spec.summary       = 'Easyship OAuth JWT assertion extension for Doorkeeper'
+  spec.description   = 'Extend your Doorkeeper implementation adding a new grant type: assertion. And decoding JWT claim messages to generate access tokens.'
+  spec.homepage      = 'https://github.com/easyship/easyship-doorkeeper-jwt'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'doorkeeper', '~> 3.1'
+  spec.add_dependency 'jwt', '~> 1.5', '>= 1.5.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 11.0'
+end

data/lib/doorkeeper/jwt_assertion.rb

@@ -0,0 +1,82 @@
+require 'doorkeeper/jwt_assertion/version'
+require 'doorkeeper/request/assertion'
+require 'doorkeeper/jwt_assertion/railtie'
+
+require 'jwt'
+
+module Doorkeeper
+  module JWTAssertion
+    attr_reader :jwt, :jwt_header
+  end
+end
+
+module Doorkeeper
+  class Server
+    attr_reader :jwt
+
+    def jwt=(jwt)
+      @jwt = jwt
+      context.instance_variable_set('@jwt', jwt)
+    end
+
+    def jwt_header=(jwt_header)
+      @jwt_header = jwt_header
+      context.instance_variable_set('@jwt_header', jwt_header)
+    end
+  end
+end
+
+module Doorkeeper
+  class Config
+    option :jwt_key
+    option :jwt_use_issuer_as_client_id, default: true
+    option :jwt_use_application_public_key_as_key, default: true
+
+    class Builder
+      def jwt_secret(key)
+        set_jwt(key)
+      end
+
+      def jwt_private_key(key_file, passphrase = nil)
+        key = OpenSSL::PKey::RSA.new(File.open(key_file), passphrase)
+        set_jwt(key)
+      end
+
+      def jwt_enable(flag)
+        enable_jwt if flag
+      end
+
+      private
+
+      def set_jwt(key)
+        jwt_key key
+      end
+
+      def enable_jwt
+        Config.class_eval do
+          alias_method :remember_calculate_token_grant_types, :calculate_token_grant_types
+          define_method :calculate_token_grant_types do
+            remember_calculate_token_grant_types << 'assertion' << 'urn:ietf:params:oauth:grant-type:jwt-bearer'
+          end
+        end
+      end
+    end
+  end
+end
+
+module Doorkeeper
+  module Errors
+    class ExpiredSignature < DoorkeeperError
+    end
+  end
+end
+
+module Doorkeeper
+  module Easyship
+    class TokenGenerator
+      def self.generate(options = {})
+        "#{::Rails.env[0..3]}_" + Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), SecureRandom.hex, options.to_s))
+      end
+    end
+  end
+end

data/lib/doorkeeper/jwt_assertion/railtie.rb

@@ -0,0 +1,9 @@
+module Doorkeeper
+  module JWTAssertion
+    class Railtie < ::Rails::Railtie
+      initializer 'doorkeeper.jwt_assertion' do
+        Doorkeeper::Helpers::Controller.send :include, Doorkeeper::JWTAssertion
+      end
+    end
+  end
+end

data/lib/doorkeeper/jwt_assertion/version.rb

@@ -0,0 +1,5 @@
+module Doorkeeper
+  module JwtAssertion
+    VERSION = '0.0.1'
+  end
+end

data/lib/doorkeeper/oauth/assertion_access_token_request.rb

@@ -0,0 +1,151 @@
+require 'doorkeeper/oauth/describable_error_response'
+
+module Doorkeeper
+  module OAuth
+    class AssertionAccessTokenRequest
+      include Validations
+      include OAuth::RequestConcern
+      include OAuth::Helpers
+
+      attr_accessor :server, :original_scopes
+      attr_reader :resource_owner, :client, :configuration, :access_token, :response, :error_description
+
+      validate :assertion,      error: :invalid_grant
+      validate :client,         error: :invalid_client
+      validate :scopes,         error: :invalid_scope
+      validate :resource_owner, error: :invalid_grant
+      validate :access_token,   error: :invalid_grant
+
+      ##
+      # @see https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12#section-2.1
+      #
+      def initialize(server, configuration)
+        @server          = server
+        @configuration   = configuration
+        @response        = nil
+        @original_scopes = server.parameters[:scope]
+      end
+
+      def authorize
+        validate
+        if valid?
+          @response = TokenResponse.new(access_token)
+        else
+          @response = DescribableErrorResponse.from_request(self)
+          @response.description = error_description
+          @response
+        end
+      end
+
+      private
+
+      ##
+      # >   The value of the "grant_type" is "urn:ietf:params:oauth:grant-
+      # >   type:jwt-bearer".
+      # >   The value of the "assertion" parameter MUST contain a single JWT.
+      # > - draft-ietf-oauth-jwt-bearer-12
+      #
+      # @see https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12#section-2.1
+      #
+      # >   assertion_type
+      # >         REQUIRED.  The format of the assertion as defined by the
+      # >         authorization server.  The value MUST be an absolute URI.
+      # >
+      # >   assertion
+      # >         REQUIRED.  The assertion.
+      # >
+      # > - draft-ietf-oauth-v2-10
+      # @see http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-4.1.3
+      #
+      # Newer versions of ietf-oauth-v2 don't need assertion_type. So it's still optional.
+      def validate_assertion
+        assertion, assertion_type = server.parameters.values_at(:assertion, :assertion_type)
+
+        if assertion_type and assertion_type != 'urn:ietf:params:oauth:grant-type:jwt-bearer'
+          raise StandardError.new('Assertion type not valid. Expected urn:ietf:params:oauth:grant-type:jwt-bearer')
+        end
+
+        if configuration.jwt_use_application_public_key_as_key
+          payload, header = JWT.decode(assertion, nil, false)
+          raise StandardError.new('App ID is not correct') unless OAuth::Client.find(payload['iss']).present?
+          public_key = OAuth::Client.find(payload['iss']).application.public_key
+          payload, header = JWT.decode(assertion, OpenSSL::PKey::RSA.new(public_key), true, { algorithm: header['alg'] })
+        else
+          payload, header = JWT.decode(assertion, configuration.jwt_key)
+        end
+        server.jwt = payload
+        server.jwt_header = header
+
+      rescue => error
+        @error_description = error.message
+        false
+      end
+
+      ##
+      # If `jwt_use_issuer_as_client_id` is `true` then validate the client using the issuer as the client_id.
+      # Otherwise, use the client_id directly from the parameters.
+      #
+      # >   Authentication of the client is optional, as described in
+      # >   Section 3.2.1 of OAuth 2.0 [RFC6749] and consequently, the
+      # >   "client_id" is only needed when a form of client authentication that
+      # >   relies on the parameter is used.
+      # > - draft-ietf-oauth-assertions-18
+      #
+      # @see https://tools.ietf.org/html/draft-ietf-oauth-assertions-18#section-4.1
+      #
+      # >   The JWT MUST contain an "iss" (issuer) claim that contains a
+      # >   unique identifier for the entity that issued the JWT.
+      # > - draft-ietf-oauth-jwt-bearer-12
+      #
+      # @see https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12#section-3
+      #
+      def validate_client
+        @client ||= if configuration.jwt_use_issuer_as_client_id
+                      OAuth::Client.find(server.jwt['iss']) if server.jwt['iss'].present?
+                    elsif sever.parameters[:client_id].present?
+                      OAuth::Client.find(sever.parameters[:client_id])
+                    end
+      end
+
+      ##
+      # >   The "scope" parameter may be used, as defined in the Assertion
+      # >   Framework for OAuth 2.0 Client Authentication and Authorization
+      # >   Grants [I-D.ietf-oauth-assertions] specification, to indicate the
+      # >   requested scope.
+      #
+      # @see https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12#section-2.1
+      #
+      def validate_scopes
+        @original_scopes = @original_scopes || server.jwt['scope']
+        return true unless @original_scopes
+        ScopeChecker.valid? @original_scopes, configuration.scopes, client.try(:scopes)
+      end
+
+      def validate_resource_owner
+        resource_owner || (@resource_owner = client.try(:application).try(:owner) || server.current_resource_owner)
+      end
+
+      def validate_access_token
+        access_token or create_token
+      end
+
+      ##
+      # >  [...] refresh tokens are not issued
+      # >  in response to assertion grant requests and access tokens will be
+      # >  issued with a reasonably short lifetime.
+      #
+      # @see https://tools.ietf.org/html/draft-ietf-oauth-assertions-18#section-4.1
+      #
+      def create_token
+        client_requested_expires_in = server.jwt['exp'].to_i - server.jwt['iat'].to_i
+        server_expires_in           = Authorization::Token.access_token_expires_in(configuration, client)
+        if server_expires_in
+          expires_in = (client_requested_expires_in > 0 && client_requested_expires_in <= server_expires_in) ? client_requested_expires_in : server_expires_in
+        else
+          expires_in = nil
+        end
+        @access_token = AccessToken.find_or_create_for(client, resource_owner.id, scopes, expires_in, configuration.refresh_token_enabled?)
+      end
+    end
+  end
+end

data/lib/doorkeeper/oauth/describable_error_response.rb

@@ -0,0 +1,7 @@
+module Doorkeeper
+  module OAuth
+    class DescribableErrorResponse < ErrorResponse
+      attr_accessor :description
+    end
+  end
+end

data/lib/doorkeeper/request/assertion.rb

@@ -0,0 +1,25 @@
+require 'doorkeeper/oauth/assertion_access_token_request'
+
+module Doorkeeper
+  module Request
+    class Assertion
+      def self.build(server)
+        new(server)
+      end
+
+      attr_reader :server
+
+      def initialize(server)
+        @server = server
+      end
+
+      def request
+        @request ||= OAuth::AssertionAccessTokenRequest.new(server, Doorkeeper.configuration)
+      end
+
+      def authorize
+        request.authorize
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: easyship-doorkeeper-jwt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- AlohaCC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: doorkeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: 'Extend your Doorkeeper implementation adding a new grant type: assertion.
+  And decoding JWT claim messages to generate access tokens.'
+email:
+- y.alohac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easyship-doorkeeper-jwt.gemspec
+- lib/doorkeeper/jwt_assertion.rb
+- lib/doorkeeper/jwt_assertion/railtie.rb
+- lib/doorkeeper/jwt_assertion/version.rb
+- lib/doorkeeper/oauth/assertion_access_token_request.rb
+- lib/doorkeeper/oauth/describable_error_response.rb
+- lib/doorkeeper/request/assertion.rb
+homepage: https://github.com/easyship/easyship-doorkeeper-jwt
+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.11
+signing_key: 
+specification_version: 4
+summary: Easyship OAuth JWT assertion extension for Doorkeeper
+test_files: []