doorkeeper 5.0.3 → 5.1.0

data/spec/models/doorkeeper/application_spec.rb

@@ -1,374 +1,366 @@
 # frozen_string_literal: true
 
 require "spec_helper"
+require "bcrypt"
 
-describe Doorkeeper::Application do
-  let(:require_owner) { Doorkeeper.configuration.instance_variable_set("@confirm_application_owner", true) }
-  let(:unset_require_owner) { Doorkeeper.configuration.instance_variable_set("@confirm_application_owner", false) }
-  let(:new_application) { FactoryBot.build(:application) }
+module Doorkeeper
+  describe Application do
+    let(:clazz) { Doorkeeper::Application }
+    let(:require_owner) { Doorkeeper.configuration.instance_variable_set("@confirm_application_owner", true) }
+    let(:unset_require_owner) { Doorkeeper.configuration.instance_variable_set("@confirm_application_owner", false) }
+    let(:new_application) { FactoryBot.build(:application) }
 
-  let(:uid) { SecureRandom.hex(8) }
-  let(:secret) { SecureRandom.hex(8) }
+    let(:uid) { SecureRandom.hex(8) }
+    let(:secret) { SecureRandom.hex(8) }
 
-  it "is invalid without a name" do
-    new_application.name = nil
-    expect(new_application).not_to be_valid
-  end
-
-  it "is invalid without determining confidentiality" do
-    new_application.confidential = nil
-    expect(new_application).not_to be_valid
-  end
+    context "application_owner is enabled" do
+      before do
+        Doorkeeper.configure do
+          orm DOORKEEPER_ORM
+          enable_application_owner
+        end
+      end
 
-  it "generates uid on create" do
-    expect(new_application.uid).to be_nil
-    new_application.save
-    expect(new_application.uid).not_to be_nil
-  end
+      context "application owner is not required" do
+        before(:each) do
+          unset_require_owner
+        end
 
-  it "generates uid on create if an empty string" do
-    new_application.uid = ""
-    new_application.save
-    expect(new_application.uid).not_to be_blank
-  end
+        it "is valid given valid attributes" do
+          expect(new_application).to be_valid
+        end
+      end
 
-  it "generates uid on create unless one is set" do
-    new_application.uid = uid
-    new_application.save
-    expect(new_application.uid).to eq(uid)
-  end
+      context "application owner is required" do
+        before(:each) do
+          require_owner
+          @owner = FactoryBot.build_stubbed(:doorkeeper_testing_user)
+        end
 
-  it "is invalid without uid" do
-    new_application.save
-    new_application.uid = nil
-    expect(new_application).not_to be_valid
-  end
+        it "is invalid without an owner" do
+          expect(new_application).not_to be_valid
+        end
 
-  it "checks uniqueness of uid" do
-    app1 = FactoryBot.create(:application)
-    app2 = FactoryBot.create(:application)
-    app2.uid = app1.uid
-    expect(app2).not_to be_valid
-  end
+        it "is valid with an owner" do
+          new_application.owner = @owner
+          expect(new_application).to be_valid
+        end
+      end
+    end
 
-  it "expects database to throw an error when uids are the same" do
-    app1 = FactoryBot.create(:application)
-    app2 = FactoryBot.create(:application)
-    app2.uid = app1.uid
-    expect { app2.save!(validate: false) }.to raise_error(uniqueness_error)
-  end
+    it "is invalid without a name" do
+      new_application.name = nil
+      expect(new_application).not_to be_valid
+    end
 
-  it "generate secret on create" do
-    expect(new_application.secret).to be_nil
-    new_application.save
-    expect(new_application.secret).not_to be_nil
-  end
+    it "is invalid without determining confidentiality" do
+      new_application.confidential = nil
+      expect(new_application).not_to be_valid
+    end
 
-  it "generate secret on create if is blank string" do
-    new_application.secret = ""
-    new_application.save
-    expect(new_application.secret).not_to be_blank
-  end
+    it "generates uid on create" do
+      expect(new_application.uid).to be_nil
+      new_application.save
+      expect(new_application.uid).not_to be_nil
+    end
 
-  it "generate secret on create unless one is set" do
-    new_application.secret = secret
-    new_application.save
-    expect(new_application.secret).to eq(secret)
-  end
+    it "generates uid on create if an empty string" do
+      new_application.uid = ""
+      new_application.save
+      expect(new_application.uid).not_to be_blank
+    end
 
-  it "is invalid without secret" do
-    new_application.save
-    new_application.secret = nil
-    expect(new_application).not_to be_valid
-  end
+    it "generates uid on create unless one is set" do
+      new_application.uid = uid
+      new_application.save
+      expect(new_application.uid).to eq(uid)
+    end
 
-  context "application_owner is enabled" do
-    before do
-      Doorkeeper.configure do
-        orm DOORKEEPER_ORM
-        enable_application_owner
-      end
+    it "is invalid without uid" do
+      new_application.save
+      new_application.uid = nil
+      expect(new_application).not_to be_valid
     end
 
-    context "application owner is not required" do
-      before(:each) do
-        unset_require_owner
-      end
+    context "redirect URI" do
+      context "when grant flows allow blank redirect URI" do
+        before do
+          Doorkeeper.configure do
+            grant_flows %w[password client_credentials]
+          end
+        end
 
-      it "is valid given valid attributes" do
-        expect(new_application).to be_valid
+        it "is valid without redirect_uri" do
+          new_application.save
+          new_application.redirect_uri = nil
+          expect(new_application).to be_valid
+        end
       end
-    end
 
-    context "application owner is required" do
-      before do
-        require_owner
-        @owner = FactoryBot.build_stubbed(:doorkeeper_testing_user)
-      end
+      context "when grant flows require redirect URI" do
+        before do
+          Doorkeeper.configure do
+            grant_flows %w[password client_credentials authorization_code]
+          end
+        end
 
-      it "is invalid without an owner" do
-        expect(new_application).not_to be_valid
+        it "is invalid without redirect_uri" do
+          new_application.save
+          new_application.redirect_uri = nil
+          expect(new_application).not_to be_valid
+        end
       end
 
-      it "is valid with an owner" do
-        new_application.owner = @owner
-        expect(new_application).to be_valid
+      context "when blank URI option disabled" do
+        before do
+          Doorkeeper.configure do
+            grant_flows %w[password client_credentials]
+            allow_blank_redirect_uri false
+          end
+        end
+
+        it "is invalid without redirect_uri" do
+          new_application.save
+          new_application.redirect_uri = nil
+          expect(new_application).not_to be_valid
+        end
       end
     end
-  end
 
-  context "redirect URI" do
-    it "is invalid without redirect_uri" do
-      new_application.save
-      new_application.redirect_uri = nil
-      expect(new_application).not_to be_valid
+    it "checks uniqueness of uid" do
+      app1 = FactoryBot.create(:application)
+      app2 = FactoryBot.create(:application)
+      app2.uid = app1.uid
+      expect(app2).not_to be_valid
     end
-  end
 
-  describe "destroy related models on cascade" do
-    before(:each) do
-      new_application.save
+    it "expects database to throw an error when uids are the same" do
+      app1 = FactoryBot.create(:application)
+      app2 = FactoryBot.create(:application)
+      app2.uid = app1.uid
+      expect { app2.save!(validate: false) }.to raise_error(uniqueness_error)
     end
 
-    let(:resource_owner) { FactoryBot.create(:doorkeeper_testing_user) }
+    it "generate secret on create" do
+      expect(new_application.secret).to be_nil
+      new_application.save
+      expect(new_application.secret).not_to be_nil
+    end
 
-    it "should destroy its access grants" do
-      FactoryBot.create(
-        :access_grant,
-        application: new_application,
-        resource_owner_id: resource_owner.id,
-      )
+    it "generate secret on create if is blank string" do
+      new_application.secret = ""
+      new_application.save
+      expect(new_application.secret).not_to be_blank
+    end
 
-      expect { new_application.destroy }.to change { Doorkeeper::AccessGrant.count }.by(-1)
+    it "generate secret on create unless one is set" do
+      new_application.secret = secret
+      new_application.save
+      expect(new_application.secret).to eq(secret)
     end
 
-    it "should destroy its access tokens" do
-      FactoryBot.create(:access_token, application: new_application)
-      FactoryBot.create(:access_token, application: new_application, revoked_at: Time.now.utc)
-      expect do
-        new_application.destroy
-      end.to change { Doorkeeper::AccessToken.count }.by(-2)
+    it "is invalid without secret" do
+      new_application.save
+      new_application.secret = nil
+      expect(new_application).not_to be_valid
     end
-  end
 
-  describe "#ordered_by" do
-    let(:applications) { FactoryBot.create_list(:application, 5) }
+    context "with hashing enabled" do
+      include_context "with application hashing enabled"
+      let(:app) { FactoryBot.create :application }
+      let(:default_strategy) { Doorkeeper::SecretStoring::Sha256Hash }
 
-    context "when a direction is not specified" do
-      it "calls order with a default order of asc" do
-        names = applications.map(&:name).sort
-        expect(described_class.ordered_by(:name).map(&:name)).to eq(names)
+      it "uses SHA256 to avoid additional dependencies" do
+        # Ensure token was generated
+        app.validate
+        expect(app.secret).to eq(default_strategy.transform_secret(app.plaintext_secret))
       end
-    end
 
-    context "when a direction is specified" do
-      it "calls order with specified direction" do
-        names = applications.map(&:name).sort.reverse
-        expect(described_class.ordered_by(:name, :desc).map(&:name)).to eq(names)
-      end
-    end
-  end
+      context "when bcrypt strategy is configured" do
+        # In this text context, we have bcrypt loaded so `bcrypt_present?`
+        # will always be true
+        before do
+          Doorkeeper.configure do
+            hash_application_secrets using: "Doorkeeper::SecretStoring::BCrypt"
+          end
+        end
 
-  describe "#redirect_uri=" do
-    context "when array of valid redirect_uris" do
-      it "should join by newline" do
-        new_application.redirect_uri = ["http://localhost/callback1", "http://localhost/callback2"]
-        expect(new_application.redirect_uri).to eq("http://localhost/callback1\nhttp://localhost/callback2")
-      end
-    end
-    context "when string of valid redirect_uris" do
-      it "should store as-is" do
-        new_application.redirect_uri = "http://localhost/callback1\nhttp://localhost/callback2"
-        expect(new_application.redirect_uri).to eq("http://localhost/callback1\nhttp://localhost/callback2")
+        it "holds a volatile plaintext and BCrypt secret" do
+          expect(app.secret_strategy).to eq Doorkeeper::SecretStoring::BCrypt
+          expect(app.plaintext_secret).to be_a(String)
+          expect(app.secret).not_to eq(app.plaintext_secret)
+          expect { ::BCrypt::Password.create(app.secret) }.not_to raise_error
+        end
       end
-    end
-  end
 
-  describe "#authorized_for" do
-    let(:resource_owner) { FactoryBot.create(:doorkeeper_testing_user) }
-    let(:other_resource_owner) { FactoryBot.create(:doorkeeper_testing_user) }
+      it "does not fallback to plain lookup by default" do
+        lookup = clazz.by_uid_and_secret(app.uid, app.secret)
+        expect(lookup).to eq(nil)
 
-    it "is empty if the application is not authorized for anyone" do
-      expect(described_class.authorized_for(resource_owner)).to be_empty
-    end
+        lookup = clazz.by_uid_and_secret(app.uid, app.plaintext_secret)
+        expect(lookup).to eq(app)
+      end
 
-    it "returns only application for a specific resource owner" do
-      FactoryBot.create(
-        :access_token,
-        resource_owner_id: other_resource_owner.id,
-      )
-      token = FactoryBot.create(
-        :access_token,
-        resource_owner_id: resource_owner.id,
-      )
-      expect(described_class.authorized_for(resource_owner)).to eq([token.application])
-    end
+      context "with fallback enabled" do
+        include_context "with token hashing and fallback lookup enabled"
 
-    it "excludes revoked tokens" do
-      FactoryBot.create(
-        :access_token,
-        resource_owner_id: resource_owner.id,
-        revoked_at: 2.days.ago,
-      )
-      expect(described_class.authorized_for(resource_owner)).to be_empty
-    end
+        it "provides plain and hashed lookup" do
+          lookup = clazz.by_uid_and_secret(app.uid, app.secret)
+          expect(lookup).to eq(app)
 
-    it "returns all applications that have been authorized" do
-      token1 = FactoryBot.create(
-        :access_token,
-        resource_owner_id: resource_owner.id,
-      )
-      token2 = FactoryBot.create(
-        :access_token,
-        resource_owner_id: resource_owner.id,
-      )
-      expect(described_class.authorized_for(resource_owner))
-        .to eq([token1.application, token2.application])
-    end
+          lookup = clazz.by_uid_and_secret(app.uid, app.plaintext_secret)
+          expect(lookup).to eq(app)
+        end
+      end
 
-    it "returns only one application even if it has been authorized twice" do
-      application = FactoryBot.create(:application)
-      FactoryBot.create(
-        :access_token,
-        resource_owner_id: resource_owner.id,
-        application: application,
-      )
-      FactoryBot.create(
-        :access_token,
-        resource_owner_id: resource_owner.id,
-        application: application,
-      )
-      expect(described_class.authorized_for(resource_owner)).to eq([application])
+      it "does not provide access to secret after loading" do
+        lookup = clazz.by_uid_and_secret(app.uid, app.plaintext_secret)
+        expect(lookup.plaintext_secret).to be_nil
+      end
     end
-  end
 
-  describe "#revoke_tokens_and_grants_for" do
-    it "revokes all access tokens and access grants" do
-      application_id = 42
-      resource_owner = double
-      expect(Doorkeeper::AccessToken)
-        .to receive(:revoke_all_for).with(application_id, resource_owner)
-      expect(Doorkeeper::AccessGrant)
-        .to receive(:revoke_all_for).with(application_id, resource_owner)
+    describe "destroy related models on cascade" do
+      before(:each) do
+        new_application.save
+      end
+
+      it "should destroy its access grants" do
+        FactoryBot.create(:access_grant, application: new_application)
+        expect { new_application.destroy }.to change { Doorkeeper::AccessGrant.count }.by(-1)
+      end
 
-      described_class.revoke_tokens_and_grants_for(application_id, resource_owner)
+      it "should destroy its access tokens" do
+        FactoryBot.create(:access_token, application: new_application)
+        FactoryBot.create(:access_token, application: new_application, revoked_at: Time.now.utc)
+        expect do
+          new_application.destroy
+        end.to change { Doorkeeper::AccessToken.count }.by(-2)
+      end
     end
-  end
 
-  describe "#by_uid_and_secret" do
-    context "when application is private/confidential" do
-      it "finds the application via uid/secret" do
-        app = FactoryBot.create :application
-        authenticated = described_class.by_uid_and_secret(app.uid, app.secret)
-        expect(authenticated).to eq(app)
+    describe :ordered_by do
+      let(:applications) { FactoryBot.create_list(:application, 5) }
+
+      context "when a direction is not specified" do
+        it "calls order with a default order of asc" do
+          names = applications.map(&:name).sort
+          expect(Application.ordered_by(:name).map(&:name)).to eq(names)
+        end
       end
-      context "when secret is wrong" do
-        it "should not find the application" do
-          app = FactoryBot.create :application
-          authenticated = described_class.by_uid_and_secret(app.uid, "bad")
-          expect(authenticated).to eq(nil)
+
+      context "when a direction is specified" do
+        it "calls order with specified direction" do
+          names = applications.map(&:name).sort.reverse
+          expect(Application.ordered_by(:name, :desc).map(&:name)).to eq(names)
         end
       end
     end
 
-    context "when application is public/non-confidential" do
-      context "when secret is blank" do
-        it "should find the application" do
-          app = FactoryBot.create :application, confidential: false
-          authenticated = described_class.by_uid_and_secret(app.uid, nil)
-          expect(authenticated).to eq(app)
+    describe "#redirect_uri=" do
+      context "when array of valid redirect_uris" do
+        it "should join by newline" do
+          new_application.redirect_uri = ["http://localhost/callback1", "http://localhost/callback2"]
+          expect(new_application.redirect_uri).to eq("http://localhost/callback1\nhttp://localhost/callback2")
         end
       end
-      context "when secret is wrong" do
-        it "should not find the application" do
-          app = FactoryBot.create :application, confidential: false
-          authenticated = described_class.by_uid_and_secret(app.uid, "bad")
-          expect(authenticated).to eq(nil)
+      context "when string of valid redirect_uris" do
+        it "should store as-is" do
+          new_application.redirect_uri = "http://localhost/callback1\nhttp://localhost/callback2"
+          expect(new_application.redirect_uri).to eq("http://localhost/callback1\nhttp://localhost/callback2")
         end
       end
     end
-  end
 
-  describe "#confidential?" do
-    subject { FactoryBot.create(:application, confidential: confidential).confidential? }
+    describe :authorized_for do
+      let(:resource_owner) { double(:resource_owner, id: 10) }
 
-    context "when application is private/confidential" do
-      let(:confidential) { true }
-      it { expect(subject).to eq(true) }
-    end
-
-    context "when application is public/non-confidential" do
-      let(:confidential) { false }
-      it { expect(subject).to eq(false) }
-    end
-  end
-
-  describe "#as_json" do
-    let(:app) { FactoryBot.create :application, secret: "123123123" }
+      it "is empty if the application is not authorized for anyone" do
+        expect(Application.authorized_for(resource_owner)).to be_empty
+      end
 
-    # AR specific feature
-    if DOORKEEPER_ORM == :active_record
-      it "correctly works with #to_json" do
-        ActiveRecord::Base.include_root_in_json = true
-        expect(app.to_json(include_root_in_json: true)).to match(/application.+?:\{/)
-        ActiveRecord::Base.include_root_in_json = false
+      it "returns only application for a specific resource owner" do
+        FactoryBot.create(:access_token, resource_owner_id: resource_owner.id + 1)
+        token = FactoryBot.create(:access_token, resource_owner_id: resource_owner.id)
+        expect(Application.authorized_for(resource_owner)).to eq([token.application])
       end
-    end
 
-    context "when called without authorized resource owner" do
-      it "includes minimal set of attributes" do
-        expect(app.as_json).to match(
-          "id" => app.id,
-          "name" => app.name,
-          "created_at" => anything,
-        )
+      it "excludes revoked tokens" do
+        FactoryBot.create(:access_token, resource_owner_id: resource_owner.id, revoked_at: 2.days.ago)
+        expect(Application.authorized_for(resource_owner)).to be_empty
       end
 
-      it "includes application UID if it's public" do
-        app = FactoryBot.create :application, secret: "123123123", confidential: false
+      it "returns all applications that have been authorized" do
+        token1 = FactoryBot.create(:access_token, resource_owner_id: resource_owner.id)
+        token2 = FactoryBot.create(:access_token, resource_owner_id: resource_owner.id)
+        expect(Application.authorized_for(resource_owner)).to eq([token1.application, token2.application])
+      end
 
-        expect(app.as_json).to match(
-          "id" => app.id,
-          "name" => app.name,
-          "created_at" => anything,
-          "uid" => app.uid,
-        )
+      it "returns only one application even if it has been authorized twice" do
+        application = FactoryBot.create(:application)
+        FactoryBot.create(:access_token, resource_owner_id: resource_owner.id, application: application)
+        FactoryBot.create(:access_token, resource_owner_id: resource_owner.id, application: application)
+        expect(Application.authorized_for(resource_owner)).to eq([application])
       end
+    end
 
-      it "respects custom options" do
-        expect(app.as_json(except: :id)).not_to include("id")
-        expect(app.as_json(only: %i[name created_at secret]))
-          .to match(
-            "name" => app.name,
-            "created_at" => anything,
-          )
+    describe :revoke_tokens_and_grants_for do
+      it "revokes all access tokens and access grants" do
+        application_id = 42
+        resource_owner = double
+        expect(Doorkeeper::AccessToken)
+          .to receive(:revoke_all_for).with(application_id, resource_owner)
+        expect(Doorkeeper::AccessGrant)
+          .to receive(:revoke_all_for).with(application_id, resource_owner)
+
+        Application.revoke_tokens_and_grants_for(application_id, resource_owner)
       end
     end
 
-    context "when called with authorized resource owner" do
-      let(:owner) { FactoryBot.create(:doorkeeper_testing_user) }
-      let(:other_owner) { FactoryBot.create(:doorkeeper_testing_user) }
-      let(:app) { FactoryBot.create(:application, secret: "123123123", owner: owner) }
+    describe :by_uid_and_secret do
+      context "when application is private/confidential" do
+        it "finds the application via uid/secret" do
+          app = FactoryBot.create :application
+          authenticated = Application.by_uid_and_secret(app.uid, app.secret)
+          expect(authenticated).to eq(app)
+        end
+        context "when secret is wrong" do
+          it "should not find the application" do
+            app = FactoryBot.create :application
+            authenticated = Application.by_uid_and_secret(app.uid, "bad")
+            expect(authenticated).to eq(nil)
+          end
+        end
+      end
 
-      before do
-        Doorkeeper.configure do
-          orm DOORKEEPER_ORM
-          enable_application_owner confirmation: false
+      context "when application is public/non-confidential" do
+        context "when secret is blank" do
+          it "should find the application" do
+            app = FactoryBot.create :application, confidential: false
+            authenticated = Application.by_uid_and_secret(app.uid, nil)
+            expect(authenticated).to eq(app)
+          end
+        end
+        context "when secret is wrong" do
+          it "should not find the application" do
+            app = FactoryBot.create :application, confidential: false
+            authenticated = Application.by_uid_and_secret(app.uid, "bad")
+            expect(authenticated).to eq(nil)
+          end
         end
       end
+    end
+
+    describe :confidential? do
+      subject { FactoryBot.create(:application, confidential: confidential).confidential? }
 
-      it "includes all the attributes" do
-        expect(app.as_json(current_resource_owner: owner))
-          .to include(
-            "secret" => "123123123",
-            "redirect_uri" => app.redirect_uri,
-            "uid" => app.uid,
-          )
+      context "when application is private/confidential" do
+        let(:confidential) { true }
+        it { expect(subject).to eq(true) }
       end
 
-      it "doesn't include unsafe attributes if current owner isn't the same as owner" do
-        expect(app.as_json(current_resource_owner: other_owner))
-          .not_to include("redirect_uri")
+      context "when application is public/non-confidential" do
+        let(:confidential) { false }
+        it { expect(subject).to eq(false) }
       end
     end
   end