doorkeeper 5.2.2 → 5.5.4

data/lib/doorkeeper/models/concerns/revocable.rb

@@ -9,7 +9,7 @@ module Doorkeeper
       # @param clock [Time] time object
       #
       def revoke(clock = Time)
-        update_attribute :revoked_at, clock.now.utc
+        update_attribute(:revoked_at, clock.now.utc)
       end
 
       # Indicates whether the object has been revoked.
@@ -19,33 +19,6 @@ module Doorkeeper
       def revoked?
         !!(revoked_at && revoked_at <= Time.now.utc)
       end
-
-      # Revokes token with `:refresh_token` equal to `:previous_refresh_token`
-      # and clears `:previous_refresh_token` attribute.
-      #
-      def revoke_previous_refresh_token!
-        return unless refresh_token_revoked_on_use?
-
-        old_refresh_token&.revoke
-        update_attribute :previous_refresh_token, ""
-      end
-
-      private
-
-      # Searches for Access Token record with `:refresh_token` equal to
-      # `:previous_refresh_token` value.
-      #
-      # @return [Doorkeeper::AccessToken, nil]
-      #   Access Token record or nil if nothing found
-      #
-      def old_refresh_token
-        @old_refresh_token ||=
-          AccessToken.by_refresh_token(previous_refresh_token)
-      end
-
-      def refresh_token_revoked_on_use?
-        AccessToken.refresh_token_revoked_on_use?
-      end
     end
   end
 end

data/lib/doorkeeper/models/concerns/scopes.rb

@@ -8,7 +8,11 @@ module Doorkeeper
       end
 
       def scopes=(value)
-        super Array(value).join(" ")
+        if value.is_a?(Array)
+          super(Doorkeeper::OAuth::Scopes.from_array(value).to_s)
+        else
+          super(Doorkeeper::OAuth::Scopes.from_string(value.to_s).to_s)
+        end
       end
 
       def scopes_string

data/lib/doorkeeper/models/concerns/secret_storable.rb

@@ -25,9 +25,7 @@ module Doorkeeper
         # @return [Boolean]
         #   Whether input matches secret as per the secret strategy
         #
-        def secret_matches?(input, secret)
-          secret_strategy.secret_matches?(input, secret)
-        end
+        delegate :secret_matches?, to: :secret_strategy
 
         # Returns an instance of the Doorkeeper::AccessToken with
         # specific token value.

data/lib/doorkeeper/oauth/authorization/code.rb

@@ -4,35 +4,48 @@ module Doorkeeper
   module OAuth
     module Authorization
       class Code
-        attr_accessor :pre_auth, :resource_owner, :token
+        attr_reader :pre_auth, :resource_owner, :token
 
         def initialize(pre_auth, resource_owner)
           @pre_auth = pre_auth
           @resource_owner = resource_owner
         end
 
-        def issue_token
-          @token ||= AccessGrant.create!(access_grant_attributes)
+        def issue_token!
+          return @token if defined?(@token)
+
+          @token = Doorkeeper.config.access_grant_model.create!(access_grant_attributes)
         end
 
         def oob_redirect
           { action: :show, code: token.plaintext_token }
         end
 
+        def access_grant?
+          true
+        end
+
         private
 
         def authorization_code_expires_in
-          Doorkeeper.configuration.authorization_code_expires_in
+          Doorkeeper.config.authorization_code_expires_in
         end
 
         def access_grant_attributes
-          pkce_attributes.merge(
+          attributes = {
             application_id: pre_auth.client.id,
-            resource_owner_id: resource_owner.id,
             expires_in: authorization_code_expires_in,
             redirect_uri: pre_auth.redirect_uri,
-            scopes: pre_auth.scopes.to_s
-          )
+            scopes: pre_auth.scopes.to_s,
+          }
+
+          if Doorkeeper.config.polymorphic_resource_owner?
+            attributes[:resource_owner] = resource_owner
+          else
+            attributes[:resource_owner_id] = resource_owner.id
+          end
+
+          pkce_attributes.merge(attributes)
         end
 
         def pkce_attributes
@@ -47,7 +60,7 @@ module Doorkeeper
         # Ensures firstly, if migration with additional PKCE columns was
         # generated and migrated
         def pkce_supported?
-          Doorkeeper::AccessGrant.pkce_supported?
+          Doorkeeper.config.access_grant_model.pkce_supported?
         end
       end
     end

data/lib/doorkeeper/oauth/authorization/context.rb

@@ -4,12 +4,12 @@ module Doorkeeper
   module OAuth
     module Authorization
       class Context
-        attr_reader :client, :grant_type, :scopes
+        attr_reader :client, :grant_type, :resource_owner, :scopes
 
-        def initialize(client, grant_type, scopes)
-          @client     = client
-          @grant_type = grant_type
-          @scopes     = scopes
+        def initialize(**attributes)
+          attributes.each do |name, value|
+            instance_variable_set(:"@#{name}", value) if respond_to?(name)
+          end
         end
       end
     end

data/lib/doorkeeper/oauth/authorization/token.rb

@@ -4,10 +4,10 @@ module Doorkeeper
   module OAuth
     module Authorization
       class Token
-        attr_accessor :pre_auth, :resource_owner, :token
+        attr_reader :pre_auth, :resource_owner, :token
 
         class << self
-          def build_context(pre_auth_or_oauth_client, grant_type, scopes)
+          def build_context(pre_auth_or_oauth_client, grant_type, scopes, resource_owner)
             oauth_client = if pre_auth_or_oauth_client.respond_to?(:application)
                              pre_auth_or_oauth_client.application
                            elsif pre_auth_or_oauth_client.respond_to?(:client)
@@ -17,9 +17,10 @@ module Doorkeeper
                            end
 
             Doorkeeper::OAuth::Authorization::Context.new(
-              oauth_client,
-              grant_type,
-              scopes
+              client: oauth_client,
+              grant_type: grant_type,
+              scopes: scopes,
+              resource_owner: resource_owner,
             )
           end
 
@@ -35,7 +36,7 @@ module Doorkeeper
           end
 
           def refresh_token_enabled?(server, context)
-            if server.refresh_token_enabled?.respond_to? :call
+            if server.refresh_token_enabled?.respond_to?(:call)
               server.refresh_token_enabled?.call(context)
             else
               !!server.refresh_token_enabled?
@@ -48,18 +49,22 @@ module Doorkeeper
           @resource_owner = resource_owner
         end
 
-        def issue_token
+        def issue_token!
+          return @token if defined?(@token)
+
           context = self.class.build_context(
             pre_auth.client,
             Doorkeeper::OAuth::IMPLICIT,
-            pre_auth.scopes
-          )
-          @token ||= AccessToken.find_or_create_for(
-            pre_auth.client,
-            resource_owner.id,
             pre_auth.scopes,
-            self.class.access_token_expires_in(configuration, context),
-            false
+            resource_owner,
+          )
+
+          @token = Doorkeeper.config.access_token_model.find_or_create_for(
+            application: pre_auth.client,
+            resource_owner: resource_owner,
+            scopes: pre_auth.scopes,
+            expires_in: self.class.access_token_expires_in(Doorkeeper.config, context),
+            use_refresh_token: false,
           )
         end
 
@@ -71,12 +76,12 @@ module Doorkeeper
           }
         end
 
-        private
-
-        def configuration
-          Doorkeeper.configuration
+        def access_token?
+          true
         end
 
+        private
+
         def controller
           @controller ||= begin
             mapping = Doorkeeper::Rails::Routes.mapping[:token_info] || {}

data/lib/doorkeeper/oauth/authorization/uri_builder.rb

@@ -8,9 +8,9 @@ module Doorkeeper
       class URIBuilder
         class << self
           def uri_with_query(url, parameters = {})
-            uri            = URI.parse(url)
+            uri = URI.parse(url)
             original_query = Rack::Utils.parse_query(uri.query)
-            uri.query      = build_query(original_query.merge(parameters))
+            uri.query = build_query(original_query.merge(parameters))
             uri.to_s
           end
 
@@ -23,8 +23,8 @@ module Doorkeeper
           private
 
           def build_query(parameters = {})
-            parameters = parameters.reject { |_, v| v.blank? }
-            Rack::Utils.build_query parameters
+            parameters.reject! { |_, value| value.blank? }
+            Rack::Utils.build_query(parameters)
           end
         end
       end

data/lib/doorkeeper/oauth/authorization_code_request.rb

@@ -3,17 +3,15 @@
 module Doorkeeper
   module OAuth
     class AuthorizationCodeRequest < BaseRequest
-      validate :pkce_support, error: :invalid_request
       validate :params,       error: :invalid_request
       validate :client,       error: :invalid_client
       validate :grant,        error: :invalid_grant
-      # @see https://tools.ietf.org/html/rfc6749#section-5.2
+      # @see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2
       validate :redirect_uri, error: :invalid_grant
       validate :code_verifier, error: :invalid_grant
 
-      attr_accessor :server, :grant, :client, :redirect_uri, :access_token,
-                    :code_verifier
-      attr_reader :invalid_request_reason, :missing_param
+      attr_reader :grant, :client, :redirect_uri, :access_token, :code_verifier,
+                  :invalid_request_reason, :missing_param
 
       def initialize(server, grant, client, parameters = {})
         @server = server
@@ -32,20 +30,28 @@ module Doorkeeper
           raise Errors::InvalidGrantReuse if grant.revoked?
 
           grant.revoke
-          find_or_create_access_token(grant.application,
-                                      grant.resource_owner_id,
-                                      grant.scopes,
-                                      server)
+
+          find_or_create_access_token(
+            grant.application,
+            resource_owner,
+            grant.scopes,
+            server,
+          )
         end
+
         super
       end
 
-      def validate_pkce_support
-        @invalid_request_reason = :not_support_pkce if grant &&
-                                                       !grant.pkce_supported? &&
-                                                       code_verifier.present?
+      def resource_owner
+        if Doorkeeper.config.polymorphic_resource_owner?
+          grant.resource_owner
+        else
+          grant.resource_owner_id
+        end
+      end
 
-        @invalid_request_reason.nil?
+      def pkce_supported?
+        Doorkeeper.config.access_grant_model.pkce_supported?
       end
 
       def validate_params
@@ -71,24 +77,28 @@ module Doorkeeper
       def validate_redirect_uri
         Helpers::URIChecker.valid_for_authorization?(
           redirect_uri,
-          grant.redirect_uri
+          grant.redirect_uri,
         )
       end
 
-      # if either side (server or client) request pkce, check the verifier
-      # against the DB - if pkce is supported
+      # if either side (server or client) request PKCE, check the verifier
+      # against the DB - if PKCE is supported
       def validate_code_verifier
-        return true unless grant.uses_pkce? || code_verifier
-        return false unless grant.pkce_supported?
+        return true unless pkce_supported?
+        return grant.code_challenge.blank? if code_verifier.blank?
 
         if grant.code_challenge_method == "S256"
-          grant.code_challenge == AccessGrant.generate_code_challenge(code_verifier)
+          grant.code_challenge == generate_code_challenge(code_verifier)
         elsif grant.code_challenge_method == "plain"
           grant.code_challenge == code_verifier
         else
           false
         end
       end
+
+      def generate_code_challenge(code_verifier)
+        server_config.access_grant_model.generate_code_challenge(code_verifier)
+      end
     end
   end
 end

data/lib/doorkeeper/oauth/base_request.rb

@@ -5,11 +5,11 @@ module Doorkeeper
     class BaseRequest
       include Validations
 
-      attr_reader :grant_type
+      attr_reader :grant_type, :server
 
-      def authorize
-        validate
+      delegate :default_scopes, to: :server
 
+      def authorize
         if valid?
           before_successful_response
           @response = TokenResponse.new(access_token)
@@ -26,31 +26,27 @@ module Doorkeeper
         @scopes ||= build_scopes
       end
 
-      def default_scopes
-        server.default_scopes
-      end
-
-      def valid?
-        error.nil?
-      end
-
-      def find_or_create_access_token(client, resource_owner_id, scopes, server)
-        context = Authorization::Token.build_context(client, grant_type, scopes)
-        @access_token = AccessToken.find_or_create_for(
-          client,
-          resource_owner_id,
-          scopes,
-          Authorization::Token.access_token_expires_in(server, context),
-          Authorization::Token.refresh_token_enabled?(server, context)
+      def find_or_create_access_token(client, resource_owner, scopes, server)
+        context = Authorization::Token.build_context(client, grant_type, scopes, resource_owner)
+        @access_token = server_config.access_token_model.find_or_create_for(
+          application: client,
+          resource_owner: resource_owner,
+          scopes: scopes,
+          expires_in: Authorization::Token.access_token_expires_in(server, context),
+          use_refresh_token: Authorization::Token.refresh_token_enabled?(server, context),
         )
       end
 
       def before_successful_response
-        Doorkeeper.configuration.before_successful_strategy_response.call(self)
+        server_config.before_successful_strategy_response.call(self)
       end
 
       def after_successful_response
-        Doorkeeper.configuration.after_successful_strategy_response.call(self, @response)
+        server_config.after_successful_strategy_response.call(self, @response)
+      end
+
+      def server_config
+        Doorkeeper.config
       end
 
       private
@@ -59,10 +55,10 @@ module Doorkeeper
         if @original_scopes.present?
           OAuth::Scopes.from_string(@original_scopes)
         else
-          client_scopes = @client.try(:scopes)
+          client_scopes = @client&.scopes
           return default_scopes if client_scopes.blank?
 
-          default_scopes & @client.scopes
+          default_scopes & client_scopes
         end
       end
     end

data/lib/doorkeeper/oauth/client/credentials.rb

@@ -9,7 +9,7 @@ module Doorkeeper
             credentials_methods.inject(nil) do |_, method|
               method = self.method(method) if method.is_a?(Symbol)
               credentials = Credentials.new(*method.call(request))
-              break credentials unless credentials.blank?
+              break credentials if credentials.present?
             end
           end
 
@@ -27,9 +27,7 @@ module Doorkeeper
 
         # Public clients may have their secret blank, but "credentials" are
         # still present
-        def blank?
-          uid.blank?
-        end
+        delegate :blank?, to: :uid
       end
     end
   end

data/lib/doorkeeper/oauth/client.rb

@@ -3,7 +3,7 @@
 module Doorkeeper
   module OAuth
     class Client
-      attr_accessor :application
+      attr_reader :application
 
       delegate :id, :name, :uid, :redirect_uri, :scopes, to: :@application
 
@@ -11,18 +11,17 @@ module Doorkeeper
         @application = application
       end
 
-      def self.find(uid, method = Application.method(:by_uid))
-        if (application = method.call(uid))
-          new(application)
-        end
+      def self.find(uid, method = Doorkeeper.config.application_model.method(:by_uid))
+        return unless (application = method.call(uid))
+
+        new(application)
       end
 
-      def self.authenticate(credentials, method = Application.method(:by_uid_and_secret))
+      def self.authenticate(credentials, method = Doorkeeper.config.application_model.method(:by_uid_and_secret))
         return if credentials.blank?
+        return unless (application = method.call(credentials.uid, credentials.secret))
 
-        if (application = method.call(credentials.uid, credentials.secret))
-          new(application)
-        end
+        new(application)
       end
     end
   end

data/lib/doorkeeper/oauth/client_credentials/creator.rb

@@ -2,27 +2,53 @@
 
 module Doorkeeper
   module OAuth
-    class ClientCredentialsRequest < BaseRequest
+    module ClientCredentials
       class Creator
         def call(client, scopes, attributes = {})
-          existing_token = existing_token_for(client, scopes)
+          existing_token = nil
 
-          if Doorkeeper.configuration.reuse_access_token && existing_token&.reusable?
-            return existing_token
+          if lookup_existing_token?
+            existing_token = find_existing_token_for(client, scopes)
+            return existing_token if server_config.reuse_access_token && existing_token&.reusable?
           end
 
-          existing_token&.revoke
-
-          AccessToken.find_or_create_for(
-            client, nil, scopes, attributes[:expires_in],
-            attributes[:use_refresh_token]
-          )
+          with_revocation(existing_token: existing_token) do
+            server_config.access_token_model.find_or_create_for(
+              application: client,
+              resource_owner: nil,
+              scopes: scopes,
+              **attributes,
+            )
+          end
         end
 
         private
 
-        def existing_token_for(client, scopes)
-          Doorkeeper::AccessToken.matching_token_for client, nil, scopes
+        def with_revocation(existing_token:)
+          if existing_token && server_config.revoke_previous_client_credentials_token?
+            existing_token.with_lock do
+              raise Errors::DoorkeeperError, :invalid_token_reuse if existing_token.revoked?
+
+              existing_token.revoke
+
+              yield
+            end
+          else
+            yield
+          end
+        end
+
+        def lookup_existing_token?
+          server_config.reuse_access_token ||
+            server_config.revoke_previous_client_credentials_token?
+        end
+
+        def find_existing_token_for(client, scopes)
+          server_config.access_token_model.matching_token_for(client, nil, scopes)
+        end
+
+        def server_config
+          Doorkeeper.config
         end
       end
     end

data/lib/doorkeeper/oauth/client_credentials/issuer.rb

@@ -2,23 +2,24 @@
 
 module Doorkeeper
   module OAuth
-    class ClientCredentialsRequest < BaseRequest
+    module ClientCredentials
       class Issuer
-        attr_accessor :token, :validation, :error
+        attr_reader :token, :validator, :error
 
-        def initialize(server, validation)
+        def initialize(server, validator)
           @server = server
-          @validation = validation
+          @validator = validator
         end
 
         def create(client, scopes, creator = Creator.new)
-          if validation.valid?
+          if validator.valid?
             @token = create_token(client, scopes, creator)
             @error = :server_error unless @token
           else
             @token = false
-            @error = validation.error
+            @error = validator.error
           end
+
           @token
         end
 
@@ -28,7 +29,8 @@ module Doorkeeper
           context = Authorization::Token.build_context(
             client,
             Doorkeeper::OAuth::CLIENT_CREDENTIALS,
-            scopes
+            scopes,
+            nil,
           )
           ttl = Authorization::Token.access_token_expires_in(@server, context)
 
@@ -36,7 +38,7 @@ module Doorkeeper
             client,
             scopes,
             use_refresh_token: false,
-            expires_in: ttl
+            expires_in: ttl,
           )
         end
       end

data/lib/doorkeeper/oauth/client_credentials/{validation.rb → validator.rb}

@@ -2,8 +2,8 @@
 
 module Doorkeeper
   module OAuth
-    class ClientCredentialsRequest < BaseRequest
-      class Validation
+    module ClientCredentials
+      class Validator
         include Validations
         include OAuth::Helpers
 
@@ -26,9 +26,11 @@ module Doorkeeper
         end
 
         def validate_client_supports_grant_flow
-          Doorkeeper.configuration.allow_grant_flow_for_client?(
+          return if @client.blank?
+
+          Doorkeeper.config.allow_grant_flow_for_client?(
             Doorkeeper::OAuth::CLIENT_CREDENTIALS,
-            @client
+            @client.application,
           )
         end
 
@@ -45,7 +47,7 @@ module Doorkeeper
             scope_str: @request.scopes.to_s,
             server_scopes: @server.scopes,
             app_scopes: application_scopes,
-            grant_type: Doorkeeper::OAuth::CLIENT_CREDENTIALS
+            grant_type: Doorkeeper::OAuth::CLIENT_CREDENTIALS,
           )
         end
       end

data/lib/doorkeeper/oauth/client_credentials_request.rb

@@ -3,18 +3,12 @@
 module Doorkeeper
   module OAuth
     class ClientCredentialsRequest < BaseRequest
-      attr_accessor :server, :client, :original_scopes
-      attr_reader :response
-      attr_writer :issuer
+      attr_reader :client, :original_scopes, :response
 
       alias error_response response
 
       delegate :error, to: :issuer
 
-      def issuer
-        @issuer ||= Issuer.new(server, Validation.new(server, self))
-      end
-
       def initialize(server, client, parameters = {})
         @client = client
         @server = server
@@ -26,6 +20,13 @@ module Doorkeeper
         issuer.token
       end
 
+      def issuer
+        @issuer ||= ClientCredentials::Issuer.new(
+          server,
+          ClientCredentials::Validator.new(server, self),
+        )
+      end
+
       private
 
       def valid?