doorkeeper 5.2.6 → 5.3.0

data/lib/doorkeeper/grape/helpers.rb

@@ -39,7 +39,7 @@ module Doorkeeper
       def doorkeeper_token
         @doorkeeper_token ||= OAuth::Token.authenticate(
           decorated_request,
-          *Doorkeeper.configuration.access_token_methods
+          *Doorkeeper.config.access_token_methods,
         )
       end
 

data/lib/doorkeeper/helpers/controller.rb

@@ -17,17 +17,17 @@ module Doorkeeper
       # :doc:
       def current_resource_owner
         @current_resource_owner ||= begin
-          instance_eval(&Doorkeeper.configuration.authenticate_resource_owner)
+          instance_eval(&Doorkeeper.config.authenticate_resource_owner)
         end
       end
 
       def resource_owner_from_credentials
-        instance_eval(&Doorkeeper.configuration.resource_owner_from_credentials)
+        instance_eval(&Doorkeeper.config.resource_owner_from_credentials)
       end
 
       # :doc:
       def authenticate_admin!
-        instance_eval(&Doorkeeper.configuration.authenticate_admin)
+        instance_eval(&Doorkeeper.config.authenticate_admin)
       end
 
       def server
@@ -40,16 +40,18 @@ module Doorkeeper
       end
 
       def config_methods
-        @config_methods ||= Doorkeeper.configuration.access_token_methods
+        @config_methods ||= Doorkeeper.config.access_token_methods
       end
 
       def get_error_response_from_exception(exception)
         if exception.respond_to?(:response)
           exception.response
         elsif exception.type == :invalid_request
-          OAuth::InvalidRequestResponse.new(name: exception.type,
-                                            state: params[:state],
-                                            missing_param: exception.missing_param)
+          OAuth::InvalidRequestResponse.new(
+            name: exception.type,
+            state: params[:state],
+            missing_param: exception.missing_param,
+          )
         else
           OAuth::ErrorResponse.new(name: exception.type, state: params[:state])
         end
@@ -65,7 +67,7 @@ module Doorkeeper
       def skip_authorization?
         !!instance_exec(
           [server.current_resource_owner, @pre_auth.client],
-          &Doorkeeper.configuration.skip_authorization
+          &Doorkeeper.config.skip_authorization
         )
       end
 

data/lib/doorkeeper/models/access_grant_mixin.rb

@@ -43,10 +43,11 @@ module Doorkeeper
       #   instance of the Resource Owner model
       #
       def revoke_all_for(application_id, resource_owner, clock = Time)
-        where(application_id: application_id,
-              resource_owner_id: resource_owner.id,
-              revoked_at: nil)
-          .update_all(revoked_at: clock.now.utc)
+        where(
+          application_id: application_id,
+          resource_owner_id: resource_owner.id,
+          revoked_at: nil,
+        ).update_all(revoked_at: clock.now.utc)
       end
 
       # Implements PKCE code_challenge encoding without base64 padding as described in the spec.
@@ -102,14 +103,14 @@ module Doorkeeper
       # Determines the secret storing transformer
       # Unless configured otherwise, uses the plain secret strategy
       def secret_strategy
-        ::Doorkeeper.configuration.token_secret_strategy
+        ::Doorkeeper.config.token_secret_strategy
       end
 
       ##
       # Determine the fallback storing strategy
       # Unless configured, there will be no fallback
       def fallback_secret_strategy
-        ::Doorkeeper.configuration.token_secret_fallback_strategy
+        ::Doorkeeper.config.token_secret_fallback_strategy
       end
     end
   end

data/lib/doorkeeper/models/access_token_mixin.rb

@@ -40,6 +40,21 @@ module Doorkeeper
         find_by_plaintext_token(:refresh_token, refresh_token)
       end
 
+      # Returns an instance of the Doorkeeper::AccessToken
+      # found by previous refresh token. Keep in mind that value
+      # of the previous_refresh_token isn't encrypted using
+      # secrets strategy.
+      #
+      # @param previous_refresh_token [#to_s]
+      #   previous refresh token value (any object that responds to `#to_s`)
+      #
+      # @return [Doorkeeper::AccessToken, nil] AccessToken object or nil
+      #   if there is no record with such refresh token
+      #
+      def by_previous_refresh_token(previous_refresh_token)
+        find_by(refresh_token: previous_refresh_token)
+      end
+
       # Revokes AccessToken records that have not been revoked and associated
       # with the specific Application and Resource Owner.
       #
@@ -49,10 +64,11 @@ module Doorkeeper
       #   instance of the Resource Owner model
       #
       def revoke_all_for(application_id, resource_owner, clock = Time)
-        where(application_id: application_id,
-              resource_owner_id: resource_owner.id,
-              revoked_at: nil)
-          .update_all(revoked_at: clock.now.utc)
+        where(
+          application_id: application_id,
+          resource_owner_id: resource_owner.id,
+          revoked_at: nil,
+        ).update_all(revoked_at: clock.now.utc)
       end
 
       # Looking for not revoked Access Token with a matching set of scopes
@@ -110,9 +126,8 @@ module Doorkeeper
         return nil unless relation
 
         matching_tokens = []
-        batch_size = Doorkeeper.configuration.token_lookup_batch_size
 
-        find_access_token_in_batches(relation, batch_size: batch_size) do |batch|
+        find_access_token_in_batches(relation) do |batch|
           tokens = batch.select do |token|
             scopes_match?(token.scopes, scopes, application.try(:scopes))
           end
@@ -143,8 +158,8 @@ module Doorkeeper
         (token_scopes.sort == param_scopes.sort) &&
           Doorkeeper::OAuth::Helpers::ScopeChecker.valid?(
             scope_str: param_scopes.to_s,
-            server_scopes: Doorkeeper.configuration.scopes,
-            app_scopes: app_scopes
+            server_scopes: Doorkeeper.config.scopes,
+            app_scopes: app_scopes,
           )
       end
 
@@ -166,7 +181,7 @@ module Doorkeeper
       # @return [Doorkeeper::AccessToken] existing record or a new one
       #
       def find_or_create_for(application, resource_owner_id, scopes, expires_in, use_refresh_token)
-        if Doorkeeper.configuration.reuse_access_token
+        if Doorkeeper.config.reuse_access_token
           access_token = matching_token_for(application, resource_owner_id, scopes)
 
           return access_token if access_token&.reusable?
@@ -177,7 +192,7 @@ module Doorkeeper
           resource_owner_id: resource_owner_id,
           scopes: scopes.to_s,
           expires_in: expires_in,
-          use_refresh_token: use_refresh_token
+          use_refresh_token: use_refresh_token,
         )
       end
 
@@ -192,9 +207,11 @@ module Doorkeeper
       # @return [Doorkeeper::AccessToken] array of matching AccessToken objects
       #
       def authorized_tokens_for(application_id, resource_owner_id)
-        where(application_id: application_id,
-              resource_owner_id: resource_owner_id,
-              revoked_at: nil)
+        where(
+          application_id: application_id,
+          resource_owner_id: resource_owner_id,
+          revoked_at: nil,
+        )
       end
 
       # Convenience method for backwards-compatibility, return the last
@@ -217,14 +234,14 @@ module Doorkeeper
       # Determines the secret storing transformer
       # Unless configured otherwise, uses the plain secret strategy
       def secret_strategy
-        ::Doorkeeper.configuration.token_secret_strategy
+        ::Doorkeeper.config.token_secret_strategy
       end
 
       ##
       # Determine the fallback storing strategy
       # Unless configured, there will be no fallback
       def fallback_secret_strategy
-        ::Doorkeeper.configuration.token_secret_fallback_strategy
+        ::Doorkeeper.config.token_secret_fallback_strategy
       end
     end
 
@@ -301,8 +318,28 @@ module Doorkeeper
       end
     end
 
+    # Revokes token with `:refresh_token` equal to `:previous_refresh_token`
+    # and clears `:previous_refresh_token` attribute.
+    #
+    def revoke_previous_refresh_token!
+      return unless self.class.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 ||= self.class.by_previous_refresh_token(previous_refresh_token)
+    end
+
     # Generates refresh token with UniqueToken generator.
     #
     # @return [String] refresh token value
@@ -313,7 +350,7 @@ module Doorkeeper
     end
 
     # Generates and sets the token value with the
-    # configured Generator class (see Doorkeeper.configuration).
+    # configured Generator class (see Doorkeeper.config).
     #
     # @return [String] generated token value
     #
@@ -330,7 +367,7 @@ module Doorkeeper
         scopes: scopes,
         application: application,
         expires_in: expires_in,
-        created_at: created_at
+        created_at: created_at,
       )
 
       secret_strategy.store_secret(self, :token, @raw_token)
@@ -338,7 +375,7 @@ module Doorkeeper
     end
 
     def token_generator
-      generator_name = Doorkeeper.configuration.access_token_generator
+      generator_name = Doorkeeper.config.access_token_generator
       generator = generator_name.constantize
 
       return generator if generator.respond_to?(:generate)

data/lib/doorkeeper/models/application_mixin.rb

@@ -47,14 +47,14 @@ module Doorkeeper
       # Determines the secret storing transformer
       # Unless configured otherwise, uses the plain secret strategy
       def secret_strategy
-        ::Doorkeeper.configuration.application_secret_strategy
+        ::Doorkeeper.config.application_secret_strategy
       end
 
       ##
       # Determine the fallback storing strategy
       # Unless configured, there will be no fallback
       def fallback_secret_strategy
-        ::Doorkeeper.configuration.application_secret_fallback_strategy
+        ::Doorkeeper.config.application_secret_fallback_strategy
       end
     end
 
@@ -72,7 +72,7 @@ module Doorkeeper
     # @param input [#to_s] Plain secret provided by user
     #        (any object that responds to `#to_s`)
     #
-    # @return [true] Whether the given secret matches the stored secret
+    # @return [Boolean] Whether the given secret matches the stored secret
     #                of this application.
     #
     def secret_matches?(input)

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

@@ -11,7 +11,7 @@ module Doorkeeper
       end
 
       def validate_owner?
-        Doorkeeper.configuration.confirm_application_owner?
+        Doorkeeper.config.confirm_application_owner?
       end
     end
   end

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

@@ -11,7 +11,7 @@ module Doorkeeper
         return false if expired?
         return true unless expires_in
 
-        threshold_limit = 100 - Doorkeeper.configuration.token_reuse_limit
+        threshold_limit = 100 - Doorkeeper.config.token_reuse_limit
         expires_in_seconds >= threshold_limit * expires_in / 100
       end
     end

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

@@ -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/oauth/authorization/code.rb

@@ -12,7 +12,7 @@ module Doorkeeper
         end
 
         def issue_token
-          @token ||= AccessGrant.create!(access_grant_attributes)
+          @token ||= Doorkeeper.config.access_grant_model.create!(access_grant_attributes)
         end
 
         def oob_redirect
@@ -22,7 +22,7 @@ module Doorkeeper
         private
 
         def authorization_code_expires_in
-          Doorkeeper.configuration.authorization_code_expires_in
+          Doorkeeper.config.authorization_code_expires_in
         end
 
         def access_grant_attributes
@@ -31,7 +31,7 @@ module Doorkeeper
             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,
           )
         end
 
@@ -47,7 +47,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/token.rb

@@ -19,7 +19,7 @@ module Doorkeeper
             Doorkeeper::OAuth::Authorization::Context.new(
               oauth_client,
               grant_type,
-              scopes
+              scopes,
             )
           end
 
@@ -35,7 +35,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?
@@ -49,17 +49,20 @@ module Doorkeeper
         end
 
         def issue_token
+          return @token if defined?(@token)
+
           context = self.class.build_context(
             pre_auth.client,
             Doorkeeper::OAuth::IMPLICIT,
-            pre_auth.scopes
+            pre_auth.scopes,
           )
-          @token ||= AccessToken.find_or_create_for(
+
+          @token = configuration.access_token_model.find_or_create_for(
             pre_auth.client,
             resource_owner.id,
             pre_auth.scopes,
             self.class.access_token_expires_in(configuration, context),
-            false
+            false,
           )
         end
 
@@ -74,7 +77,7 @@ module Doorkeeper
         private
 
         def configuration
-          Doorkeeper.configuration
+          Doorkeeper.config
         end
 
         def controller

data/lib/doorkeeper/oauth/authorization_code_request.rb

@@ -32,10 +32,13 @@ 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,
+            grant.resource_owner_id,
+            grant.scopes,
+            server,
+          )
         end
         super
       end
@@ -71,7 +74,7 @@ module Doorkeeper
       def validate_redirect_uri
         Helpers::URIChecker.valid_for_authorization?(
           redirect_uri,
-          grant.redirect_uri
+          grant.redirect_uri,
         )
       end
 
@@ -82,13 +85,17 @@ module Doorkeeper
         return false unless grant.pkce_supported?
 
         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