doorkeeper 3.1.0 → 5.6.2

data/lib/doorkeeper/oauth/authorization_code_request.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
-    class AuthorizationCodeRequest
-      include Validations
-      include OAuth::RequestConcern
-
-      validate :attributes,   error: :invalid_request
+    class AuthorizationCodeRequest < BaseRequest
+      validate :params,       error: :invalid_request
       validate :client,       error: :invalid_client
       validate :grant,        error: :invalid_grant
+      # @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
+      attr_reader :grant, :client, :redirect_uri, :access_token, :code_verifier,
+                  :invalid_request_reason, :missing_param
 
       def initialize(server, grant, client, parameters = {})
         @server = server
         @client = client
         @grant  = grant
+        @grant_type = Doorkeeper::OAuth::AUTHORIZATION_CODE
         @redirect_uri = parameters[:redirect_uri]
+        @code_verifier = parameters[:code_verifier]
       end
 
       private
@@ -26,28 +30,74 @@ 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_attributes
-        redirect_uri.present?
+      def resource_owner
+        if Doorkeeper.config.polymorphic_resource_owner?
+          grant.resource_owner
+        else
+          grant.resource_owner_id
+        end
+      end
+
+      def pkce_supported?
+        Doorkeeper.config.access_grant_model.pkce_supported?
+      end
+
+      def validate_params
+        @missing_param = if grant&.uses_pkce? && code_verifier.blank?
+                           :code_verifier
+                         elsif redirect_uri.blank?
+                           :redirect_uri
+                         end
+
+        @missing_param.nil?
       end
 
       def validate_client
-        !!client
+        client.present?
       end
 
       def validate_grant
         return false unless grant && grant.application_id == client.id
+
         grant.accessible?
       end
 
       def validate_redirect_uri
-        grant.redirect_uri == redirect_uri
+        Helpers::URIChecker.valid_for_authorization?(
+          redirect_uri,
+          grant.redirect_uri,
+        )
+      end
+
+      # 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 pkce_supported?
+        return grant.code_challenge.blank? if code_verifier.blank?
+
+        if grant.code_challenge_method == "S256"
+          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

data/lib/doorkeeper/oauth/base_request.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module OAuth
+    class BaseRequest
+      include Validations
+
+      attr_reader :grant_type, :server
+
+      delegate :default_scopes, to: :server
+
+      def authorize
+        if valid?
+          before_successful_response
+          @response = TokenResponse.new(access_token)
+          after_successful_response
+          @response
+        elsif error == :invalid_request
+          @response = InvalidRequestResponse.from_request(self)
+        else
+          @response = ErrorResponse.from_request(self)
+        end
+      end
+
+      def scopes
+        @scopes ||= build_scopes
+      end
+
+      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.is_a?(server_config.application_model) ? client : client&.application,
+          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
+        server_config.before_successful_strategy_response.call(self)
+      end
+
+      def after_successful_response
+        server_config.after_successful_strategy_response.call(self, @response)
+      end
+
+      def server_config
+        Doorkeeper.config
+      end
+
+      private
+
+      def build_scopes
+        if @original_scopes.present?
+          OAuth::Scopes.from_string(@original_scopes)
+        else
+          client_scopes = @client&.scopes
+          return default_scopes if client_scopes.blank?
+
+          default_scopes & client_scopes
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/oauth/base_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module OAuth
+    class BaseResponse
+      def body
+        {}
+      end
+
+      def description
+        ""
+      end
+
+      def headers
+        {}
+      end
+
+      def redirectable?
+        false
+      end
+
+      def redirect_uri
+        ""
+      end
+
+      def status
+        :ok
+      end
+    end
+  end
+end

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

@@ -1,20 +1,33 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class Client
-      class Credentials < Struct.new(:uid, :secret)
-        extend Methods
+      Credentials = Struct.new(:uid, :secret) do
+        class << self
+          def from_request(request, *credentials_methods)
+            credentials_methods.inject(nil) do |_, method|
+              method = self.method(method) if method.is_a?(Symbol)
+              credentials = Credentials.new(*method.call(request))
+              break credentials if credentials.present?
+            end
+          end
 
-        def self.from_request(request, *credentials_methods)
-          credentials_methods.inject(nil) do |credentials, method|
-            method = self.method(method) if method.is_a?(Symbol)
-            credentials = Credentials.new *method.call(request)
-            break credentials unless credentials.blank?
+          def from_params(request)
+            request.parameters.values_at(:client_id, :client_secret)
           end
-        end
 
-        def blank?
-          uid.blank? || secret.blank?
+          def from_basic(request)
+            authorization = request.authorization
+            if authorization.present? && authorization =~ /^Basic (.*)/m
+              Base64.decode64(Regexp.last_match(1)).split(/:/, 2)
+            end
+          end
         end
+
+        # Public clients may have their secret blank, but "credentials" are
+        # still present
+        delegate :blank?, to: :uid
       end
     end
   end

data/lib/doorkeeper/oauth/client.rb

@@ -1,10 +1,9 @@
-require 'doorkeeper/oauth/client/methods'
-require 'doorkeeper/oauth/client/credentials'
+# frozen_string_literal: true
 
 module Doorkeeper
   module OAuth
     class Client
-      attr_accessor :application
+      attr_reader :application
 
       delegate :id, :name, :uid, :redirect_uri, :scopes, to: :@application
 
@@ -12,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))
-        return false if credentials.blank?
+      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

@@ -1,11 +1,55 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
-    class ClientCredentialsRequest
+    module ClientCredentials
       class Creator
         def call(client, scopes, attributes = {})
-          AccessToken.find_or_create_for(
-            client, nil, scopes, attributes[:expires_in],
-            attributes[:use_refresh_token])
+          existing_token = nil
+
+          if lookup_existing_token?
+            existing_token = find_active_existing_token_for(client, scopes)
+            return existing_token if server_config.reuse_access_token && existing_token&.reusable?
+          end
+
+          with_revocation(existing_token: existing_token) do
+            application = client.is_a?(server_config.application_model) ? client : client&.application
+            server_config.access_token_model.create_for(
+              application: application,
+              resource_owner: nil,
+              scopes: scopes,
+              **attributes,
+            )
+          end
+        end
+
+        private
+
+        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_active_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

@@ -1,36 +1,44 @@
-require 'doorkeeper/oauth/client_credentials/validation'
+# frozen_string_literal: true
 
 module Doorkeeper
   module OAuth
-    class ClientCredentialsRequest
+    module ClientCredentials
       class Issuer
-        attr_accessor :token, :validation, :error
+        attr_reader :token, :validator, :error
 
-        def initialize(server, validation)
-          @server, @validation = server, validation
+        def initialize(server, validator)
+          @server = server
+          @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
 
         private
 
         def create_token(client, scopes, creator)
-          ttl = Authorization::Token.access_token_expires_in(@server, client)
+          context = Authorization::Token.build_context(
+            client,
+            Doorkeeper::OAuth::CLIENT_CREDENTIALS,
+            scopes,
+            nil,
+          )
+          ttl = Authorization::Token.access_token_expires_in(@server, context)
 
           creator.call(
             client,
             scopes,
             use_refresh_token: false,
-            expires_in: ttl
+            expires_in: ttl,
           )
         end
       end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  module OAuth
+    module ClientCredentials
+      class Validator
+        include Validations
+        include OAuth::Helpers
+
+        validate :client, error: :invalid_client
+        validate :client_supports_grant_flow, error: :unauthorized_client
+        validate :scopes, error: :invalid_scope
+
+        def initialize(server, request)
+          @server = server
+          @request = request
+          @client = request.client
+
+          validate
+        end
+
+        private
+
+        def validate_client
+          @client.present?
+        end
+
+        def validate_client_supports_grant_flow
+          return if @client.blank?
+
+          Doorkeeper.config.allow_grant_flow_for_client?(
+            Doorkeeper::OAuth::CLIENT_CREDENTIALS,
+            @client.application,
+          )
+        end
+
+        def validate_scopes
+          application_scopes = if @client.present?
+                                 @client.application.scopes
+                               else
+                                 ""
+                               end
+          return true if @request.scopes.blank? && application_scopes.blank?
+
+          ScopeChecker.valid?(
+            scope_str: @request.scopes.to_s,
+            server_scopes: @server.scopes,
+            app_scopes: application_scopes,
+            grant_type: Doorkeeper::OAuth::CLIENT_CREDENTIALS,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/oauth/client_credentials_request.rb

@@ -1,26 +1,18 @@
-require 'doorkeeper/oauth/client_credentials/creator'
-require 'doorkeeper/oauth/client_credentials/issuer'
-require 'doorkeeper/oauth/client_credentials/validation'
+# frozen_string_literal: true
 
 module Doorkeeper
   module OAuth
-    class ClientCredentialsRequest
-      include Validations
-      include OAuth::RequestConcern
+    class ClientCredentialsRequest < BaseRequest
+      attr_reader :client, :original_scopes, :response
 
-      attr_accessor :issuer, :server, :client, :original_scopes
-      attr_reader :response
-      alias :error_response :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, @server = client, server
-        @response        = nil
+        @client = client
+        @server = server
+        @response = nil
         @original_scopes = parameters[:scope]
       end
 
@@ -28,6 +20,13 @@ module Doorkeeper
         issuer.token
       end
 
+      def issuer
+        @issuer ||= ClientCredentials::Issuer.new(
+          server,
+          ClientCredentials::Validator.new(server, self),
+        )
+      end
+
       private
 
       def valid?

data/lib/doorkeeper/oauth/code_request.rb

@@ -1,28 +1,24 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
     class CodeRequest
-      attr_accessor :pre_auth, :resource_owner, :client
+      attr_reader :pre_auth, :resource_owner
 
       def initialize(pre_auth, resource_owner)
-        @pre_auth       = pre_auth
-        @client         = pre_auth.client
+        @pre_auth = pre_auth
         @resource_owner = resource_owner
       end
 
       def authorize
-        if pre_auth.authorizable?
-          auth = Authorization::Code.new(pre_auth, resource_owner)
-          auth.issue_token
-          @response = CodeResponse.new pre_auth, auth
-        else
-          @response = ErrorResponse.from_request pre_auth
-        end
+        auth = Authorization::Code.new(pre_auth, resource_owner)
+        auth.issue_token!
+        CodeResponse.new(pre_auth, auth, response_on_fragment: pre_auth.response_mode == "fragment")
       end
 
       def deny
         pre_auth.error = :access_denied
-        ErrorResponse.from_request pre_auth,
-                                   redirect_uri: pre_auth.redirect_uri
+        pre_auth.error_response
       end
     end
   end

data/lib/doorkeeper/oauth/code_response.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
-    class CodeResponse
-      include OAuth::Authorization::URIBuilder
+    class CodeResponse < BaseResponse
       include OAuth::Helpers
 
-      attr_accessor :pre_auth, :auth, :response_on_fragment
+      attr_reader :pre_auth, :auth, :response_on_fragment
 
       def initialize(pre_auth, auth, options = {})
-        @pre_auth, @auth      = pre_auth, auth
+        @pre_auth = pre_auth
+        @auth = auth
         @response_on_fragment = options[:response_on_fragment]
       end
 
@@ -15,23 +17,33 @@ module Doorkeeper
         true
       end
 
+      def issued_token
+        auth.token
+      end
+
+      def body
+        if auth.try(:access_token?)
+          {
+            access_token: auth.token.plaintext_token,
+            token_type: auth.token.token_type,
+            expires_in: auth.token.expires_in_seconds,
+            state: pre_auth.state,
+          }
+        elsif auth.try(:access_grant?)
+          {
+            code: auth.token.plaintext_token,
+            state: pre_auth.state,
+          }
+        end
+      end
+
       def redirect_uri
-        if URIChecker.native_uri? pre_auth.redirect_uri
-          auth.native_redirect
+        if URIChecker.oob_uri?(pre_auth.redirect_uri)
+          auth.oob_redirect
+        elsif response_on_fragment
+          Authorization::URIBuilder.uri_with_fragment(pre_auth.redirect_uri, body)
         else
-          if response_on_fragment
-            uri_with_fragment(
-              pre_auth.redirect_uri,
-              access_token: auth.token.token,
-              token_type: auth.token.token_type,
-              expires_in: auth.token.expires_in,
-              state: pre_auth.state
-            )
-          else
-            uri_with_query pre_auth.redirect_uri,
-                           code: auth.token.token,
-                           state: pre_auth.state
-          end
+          Authorization::URIBuilder.uri_with_query(pre_auth.redirect_uri, body)
         end
       end
     end

data/lib/doorkeeper/oauth/error.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module OAuth
-    class Error < Struct.new(:name, :state)
+    Error = Struct.new(:name, :state) do
       def description
         I18n.translate(
           name,
-          scope: [:doorkeeper, :errors, :messages],
-          default: :server_error
+          scope: %i[doorkeeper errors messages],
+          default: :server_error,
         )
       end
     end