oauth2 1.4.10 → 2.0.8

data/lib/oauth2/strategy/assertion.rb

@@ -10,15 +10,22 @@ module OAuth2
     #
     # Sample usage:
     #   client = OAuth2::Client.new(client_id, client_secret,
-    #                               :site => 'http://localhost:8080')
+    #                               :site => 'http://localhost:8080',
+    #                               :auth_scheme => :request_body)
     #
-    #   params = {:hmac_secret => "some secret",
-    #             # or :private_key => "private key string",
-    #             :iss => "http://localhost:3001",
-    #             :prn => "me@here.com",
-    #             :exp => Time.now.utc.to_i + 3600}
+    #   claim_set = {
+    #     :iss => "http://localhost:3001",
+    #     :aud => "http://localhost:8080/oauth2/token",
+    #     :sub => "me@example.com",
+    #     :exp => Time.now.utc.to_i + 3600,
+    #   }
     #
-    #   access = client.assertion.get_token(params)
+    #   encoding = {
+    #     :algorithm => 'HS256',
+    #     :key => 'secret_key',
+    #   }
+    #
+    #   access = client.assertion.get_token(claim_set, encoding)
     #   access.token                 # actual access_token string
     #   access.get("/api/stuff")     # making api calls with access token in header
     #
@@ -32,45 +39,63 @@ module OAuth2
 
       # Retrieve an access token given the specified client.
       #
-      # @param [Hash] params assertion params
-      # pass either :hmac_secret or :private_key, but not both.
+      # @param [Hash] claims the hash representation of the claims that should be encoded as a JWT (JSON Web Token)
+      #
+      # For reading on JWT and claim keys:
+      #   @see https://github.com/jwt/ruby-jwt
+      #   @see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1
+      #   @see https://datatracker.ietf.org/doc/html/rfc7523#section-3
+      #   @see https://www.iana.org/assignments/jwt/jwt.xhtml
+      #
+      # There are many possible claim keys, and applications may ask for their own custom keys.
+      # Some typically required ones:
+      #   :iss (issuer)
+      #   :aud (audience)
+      #   :sub (subject) -- formerly :prn https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token-06#appendix-F
+      #   :exp, (expiration time) -- in seconds, e.g. Time.now.utc.to_i + 3600
+      #
+      # Note that this method does *not* validate presence of those four claim keys indicated as required by RFC 7523.
+      # There are endpoints that may not conform with this RFC, and this gem should still work for those use cases.
+      #
+      # @param [Hash] encoding_opts a hash containing instructions on how the JWT should be encoded
+      # @option algorithm [String] the algorithm with which you would like the JWT to be encoded
+      # @option key [Object] the key with which you would like to encode the JWT
       #
-      #   params :hmac_secret, secret string.
-      #   params :private_key, private key string.
+      # These two options are passed directly to `JWT.encode`.  For supported encoding arguments:
+      #   @see https://github.com/jwt/ruby-jwt#algorithms-and-usage
+      #   @see https://datatracker.ietf.org/doc/html/rfc7518#section-3.1
       #
-      #   params :iss, issuer
-      #   params :aud, audience, optional
-      #   params :prn, principal, current user
-      #   params :exp, expired at, in seconds, like Time.now.utc.to_i + 3600
+      # The object type of `:key` may depend on the value of `:algorithm`.  Sample arguments:
+      #   get_token(claim_set, {:algorithm => 'HS256', :key => 'secret_key'})
+      #   get_token(claim_set, {:algorithm => 'RS256', :key => OpenSSL::PKCS12.new(File.read('my_key.p12'), 'not_secret')})
       #
-      # @param [Hash] opts options
-      def get_token(params = {}, opts = {})
-        hash = build_request(params)
-        @client.get_token(hash, opts.merge('refresh_token' => nil))
+      # @param [Hash] request_opts options that will be used to assemble the request
+      # @option request_opts [String] :scope the url parameter `scope` that may be required by some endpoints
+      #   @see https://datatracker.ietf.org/doc/html/rfc7521#section-4.1
+      #
+      # @param [Hash] response_opts this will be merged with the token response to create the AccessToken object
+      #   @see the access_token_opts argument to Client#get_token
+
+      def get_token(claims, encoding_opts, request_opts = {}, response_opts = {})
+        assertion = build_assertion(claims, encoding_opts)
+        params = build_request(assertion, request_opts)
+
+        @client.get_token(params, response_opts)
       end
 
-      def build_request(params)
-        assertion = build_assertion(params)
+    private
+
+      def build_request(assertion, request_opts = {})
         {
-          :grant_type => 'assertion',
-          :assertion_type => 'urn:ietf:params:oauth:grant-type:jwt-bearer',
-          :assertion => assertion,
-          :scope => params[:scope],
-        }
+          grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+          assertion: assertion,
+        }.merge(request_opts)
       end
 
-      def build_assertion(params)
-        claims = {
-          :iss => params[:iss],
-          :aud => params[:aud],
-          :prn => params[:prn],
-          :exp => params[:exp],
-        }
-        if params[:hmac_secret]
-          JWT.encode(claims, params[:hmac_secret], 'HS256')
-        elsif params[:private_key]
-          JWT.encode(claims, params[:private_key], 'RS256')
-        end
+      def build_assertion(claims, encoding_opts)
+        raise ArgumentError.new(message: 'Please provide an encoding_opts hash with :algorithm and :key') if !encoding_opts.is_a?(Hash) || (%i[algorithm key] - encoding_opts.keys).any?
+
+        JWT.encode(claims, encoding_opts[:key], encoding_opts[:algorithm])
       end
     end
   end

data/lib/oauth2/strategy/auth_code.rb

@@ -17,6 +17,7 @@ module OAuth2
       #
       # @param [Hash] params additional query parameters for the URL
       def authorize_url(params = {})
+        assert_valid_params(params)
         @client.authorize_url(authorize_params.merge(params))
       end
 
@@ -24,12 +25,22 @@ module OAuth2
       #
       # @param [String] code The Authorization Code value
       # @param [Hash] params additional params
-      # @param [Hash] opts options
+      # @param [Hash] opts access_token_opts, @see Client#get_token
       # @note that you must also provide a :redirect_uri with most OAuth 2.0 providers
       def get_token(code, params = {}, opts = {})
         params = {'grant_type' => 'authorization_code', 'code' => code}.merge(@client.redirection_params).merge(params)
+        params_dup = params.dup
+        params.each_key do |key|
+          params_dup[key.to_s] = params_dup.delete(key) if key.is_a?(Symbol)
+        end
 
-        @client.get_token(params, opts)
+        @client.get_token(params_dup, opts)
+      end
+
+    private
+
+      def assert_valid_params(params)
+        raise(ArgumentError, 'client_secret is not allowed in authorize URL query params') if params.key?(:client_secret) || params.key?('client_secret')
       end
     end
   end

data/lib/oauth2/strategy/client_credentials.rb

@@ -19,7 +19,7 @@ module OAuth2
       # @param [Hash] opts options
       def get_token(params = {}, opts = {})
         params = params.merge('grant_type' => 'client_credentials')
-        @client.get_token(params, opts.merge('refresh_token' => nil))
+        @client.get_token(params, opts)
       end
     end
   end

data/lib/oauth2/strategy/implicit.rb

@@ -17,6 +17,7 @@ module OAuth2
       #
       # @param [Hash] params additional query parameters for the URL
       def authorize_url(params = {})
+        assert_valid_params(params)
         @client.authorize_url(authorize_params.merge(params))
       end
 
@@ -26,6 +27,12 @@ module OAuth2
       def get_token(*)
         raise(NotImplementedError, 'The token is accessed differently in this strategy')
       end
+
+    private
+
+      def assert_valid_params(params)
+        raise(ArgumentError, 'client_secret is not allowed in authorize URL query params') if params.key?(:client_secret) || params.key?('client_secret')
+      end
     end
   end
 end

data/lib/oauth2/version.rb

@@ -2,64 +2,6 @@
 
 module OAuth2
   module Version
-    VERSION = to_s
-
-  module_function
-
-    # The major version
-    #
-    # @return [Integer]
-    def major
-      1
-    end
-
-    # The minor version
-    #
-    # @return [Integer]
-    def minor
-      4
-    end
-
-    # The patch version
-    #
-    # @return [Integer]
-    def patch
-      10
-    end
-
-    # The pre-release version, if any
-    #
-    # @return [String, NilClass]
-    def pre
-      nil
-    end
-
-    # The version number as a hash
-    #
-    # @return [Hash]
-    def to_h
-      {
-        :major => major,
-        :minor => minor,
-        :patch => patch,
-        :pre => pre,
-      }
-    end
-
-    # The version number as an array
-    #
-    # @return [Array]
-    def to_a
-      [major, minor, patch, pre].compact
-    end
-
-    # The version number as a string
-    #
-    # @return [String]
-    def to_s
-      v = [major, minor, patch].compact.join('.')
-      v += "-#{pre}" if pre
-      v
-    end
+    VERSION = '2.0.8'.freeze
   end
 end

data/lib/oauth2.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
+# includes modules from stdlib
+require 'cgi'
+require 'time'
+
+# third party gems
+require 'snaky_hash'
+require 'version_gem'
+
+# includes gem files
+require 'oauth2/version'
 require 'oauth2/error'
 require 'oauth2/authenticator'
 require 'oauth2/client'
@@ -10,5 +20,21 @@ require 'oauth2/strategy/password'
 require 'oauth2/strategy/client_credentials'
 require 'oauth2/strategy/assertion'
 require 'oauth2/access_token'
-require 'oauth2/mac_token'
 require 'oauth2/response'
+
+# The namespace of this library
+module OAuth2
+  DEFAULT_CONFIG = SnakyHash::SymbolKeyed.new(silence_extra_tokens_warning: false)
+  @config = DEFAULT_CONFIG.dup
+  class << self
+    attr_accessor :config
+  end
+  def configure
+    yield @config
+  end
+  module_function :configure
+end
+
+OAuth2::Version.class_eval do
+  extend VersionGem::Basic
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: oauth2
 version: !ruby/object:Gem::Version
-  version: 1.4.10
+  version: 2.0.8
 platform: ruby
 authors:
 - Peter Boling
 - Erik Michaels-Ober
 - Michael Bleigh
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,20 +52,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -101,75 +87,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: snaky_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: version_gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec-block_is_expected
   requirement: !ruby/object:Gem::Requirement
@@ -216,22 +244,16 @@ dependencies:
   name: rubocop-lts
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: silent_stream
   requirement: !ruby/object:Gem::Requirement
@@ -265,7 +287,6 @@ files:
 - lib/oauth2/authenticator.rb
 - lib/oauth2/client.rb
 - lib/oauth2/error.rb
-- lib/oauth2/mac_token.rb
 - lib/oauth2/response.rb
 - lib/oauth2/strategy/assertion.rb
 - lib/oauth2/strategy/auth_code.rb
@@ -278,26 +299,24 @@ homepage: https://github.com/oauth-xx/oauth2
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/oauth-xx/oauth2
+  source_code_uri: https://github.com/oauth-xx/oauth2/tree/v2.0.8
+  changelog_uri: https://github.com/oauth-xx/oauth2/blob/v2.0.8/CHANGELOG.md
   bug_tracker_uri: https://github.com/oauth-xx/oauth2/issues
-  changelog_uri: https://github.com/oauth-xx/oauth2/blob/v1.4.10/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/oauth2/1.4.10
-  source_code_uri: https://github.com/oauth-xx/oauth2/tree/v1.4.10
+  documentation_uri: https://www.rubydoc.info/gems/oauth2/2.0.8
   wiki_uri: https://github.com/oauth-xx/oauth2/wiki
-  funding_uri: https://github.com/sponsors/pboling
   rubygems_mfa_required: 'true'
 post_install_message: |2+
 
-  You have installed oauth2 version 1.4.10, which is EOL.
-  No further support is anticipated for the 1.4.x series.
+  You have installed oauth2 version 2.0.8, congratulations!
 
-  OAuth2 version 2 is released.
-  There are BREAKING changes, but most will not encounter them, and upgrading should be easy!
+  There are BREAKING changes, but most will not encounter them, and updating your code should be easy!
 
   Please see:
   • https://github.com/oauth-xx/oauth2#what-is-new-for-v20
   • https://github.com/oauth-xx/oauth2/blob/master/CHANGELOG.md
 
-  Please upgrade, report issues, and support the project! Thanks, |7eter l-|. l3oling
+  Please report issues, and support the project! Thanks, |7eter l-|. l3oling
 
 rdoc_options: []
 require_paths:
@@ -306,15 +325,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
-signing_key: 
+rubygems_version: 3.3.21
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the OAuth 2.0 protocol.
 test_files: []
+...

data/lib/oauth2/mac_token.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-require 'base64'
-require 'digest'
-require 'openssl'
-require 'securerandom'
-
-module OAuth2
-  class MACToken < AccessToken
-    # Generates a MACToken from an AccessToken and secret
-    #
-    # @param [AccessToken] token the OAuth2::Token instance
-    # @option [String] secret the secret key value
-    # @param [Hash] opts the options to create the Access Token with
-    # @see MACToken#initialize
-    def self.from_access_token(token, secret, options = {})
-      new(token.client, token.token, secret, token.params.merge(:refresh_token => token.refresh_token, :expires_in => token.expires_in, :expires_at => token.expires_at).merge(options))
-    end
-
-    attr_reader :secret, :algorithm
-
-    # Initalize a MACToken
-    #
-    # @param [Client] client the OAuth2::Client instance
-    # @param [String] token the Access Token value
-    # @option [String] secret the secret key value
-    # @param [Hash] opts the options to create the Access Token with
-    # @option opts [String] :refresh_token (nil) the refresh_token value
-    # @option opts [FixNum, String] :expires_in (nil) the number of seconds in which the AccessToken will expire
-    # @option opts [FixNum, String] :expires_at (nil) the epoch time in seconds in which AccessToken will expire
-    # @option opts [FixNum, String] :algorithm (hmac-sha-256) the algorithm to use for the HMAC digest (one of 'hmac-sha-256', 'hmac-sha-1')
-    def initialize(client, token, secret, opts = {})
-      @secret = secret
-      self.algorithm = opts.delete(:algorithm) || 'hmac-sha-256'
-
-      super(client, token, opts)
-    end
-
-    # Make a request with the MAC Token
-    #
-    # @param [Symbol] verb the HTTP request method
-    # @param [String] path the HTTP URL path of the request
-    # @param [Hash] opts the options to make the request with
-    # @see Client#request
-    def request(verb, path, opts = {}, &block)
-      url = client.connection.build_url(path, opts[:params]).to_s
-
-      opts[:headers] ||= {}
-      opts[:headers]['Authorization'] = header(verb, url)
-
-      @client.request(verb, path, opts, &block)
-    end
-
-    # Get the headers hash (always an empty hash)
-    def headers
-      {}
-    end
-
-    # Generate the MAC header
-    #
-    # @param [Symbol] verb the HTTP request method
-    # @param [String] url the HTTP URL path of the request
-    def header(verb, url)
-      timestamp = Time.now.utc.to_i
-      nonce = Digest::SHA256.hexdigest([timestamp, SecureRandom.hex].join(':'))
-
-      uri = URI.parse(url)
-
-      raise(ArgumentError, "could not parse \"#{url}\" into URI") unless uri.is_a?(URI::HTTP)
-
-      mac = signature(timestamp, nonce, verb, uri)
-
-      "MAC id=\"#{token}\", ts=\"#{timestamp}\", nonce=\"#{nonce}\", mac=\"#{mac}\""
-    end
-
-    # Generate the Base64-encoded HMAC digest signature
-    #
-    # @param [Fixnum] timestamp the timestamp of the request in seconds since epoch
-    # @param [String] nonce the MAC header nonce
-    # @param [Symbol] verb the HTTP request method
-    # @param [String] url the HTTP URL path of the request
-    def signature(timestamp, nonce, verb, uri)
-      signature = [
-        timestamp,
-        nonce,
-        verb.to_s.upcase,
-        uri.request_uri,
-        uri.host,
-        uri.port,
-        '', nil
-      ].join("\n")
-
-      strict_encode64(OpenSSL::HMAC.digest(@algorithm, secret, signature))
-    end
-
-    # Set the HMAC algorithm
-    #
-    # @param [String] alg the algorithm to use (one of 'hmac-sha-1', 'hmac-sha-256')
-    def algorithm=(alg)
-      @algorithm = case alg.to_s
-                   when 'hmac-sha-1'
-                     begin
-                       OpenSSL::Digest('SHA1').new
-                     rescue StandardError
-                       OpenSSL::Digest.new('SHA1')
-                     end
-                   when 'hmac-sha-256'
-                     begin
-                       OpenSSL::Digest('SHA256').new
-                     rescue StandardError
-                       OpenSSL::Digest.new('SHA256')
-                     end
-                   else
-                     raise(ArgumentError, 'Unsupported algorithm')
-                   end
-    end
-
-  private
-
-    # No-op since we need the verb and path
-    # and the MAC always goes in a header
-    def token=(_noop)
-    end
-
-    # Base64.strict_encode64 is not available on Ruby 1.8.7
-    def strict_encode64(str)
-      Base64.encode64(str).delete("\n")
-    end
-  end
-end