Files
2026-02-04 15:16:09 +01:00

111 lines
3.5 KiB
Ruby

# frozen_string_literal: true
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++
require "spec_helper"
RSpec.describe Token::HashedToken do
let(:user) { build(:user) }
subject { described_class.new user: }
describe "token value" do
it "is generated on a new instance" do
expect(subject.value).to be_present
end
it "provides the generated plain value on a new instance" do
expect(subject.valid_plaintext?(subject.plain_value)).to be true
end
it "hashes the plain value to value" do
expect(subject.value).not_to eq(subject.plain_value)
end
it "does not keep the value when finding it" do
subject.save!
instance = described_class.where(user:).last
expect(instance.plain_value).to be_nil
end
end
describe "#find_by_plaintext_value" do
before do
subject.save!
end
it "finds using the plaintext value" do
expect(described_class.find_by_plaintext_value(subject.plain_value)).to eq subject
expect(described_class.find_by_plaintext_value("foobar")).to be_nil
end
end
describe ".hash_function" do
it "uses HMAC-SHA256 with Setting.hashed_token_pepper" do
allow(Setting).to receive(:hashed_token_pepper).and_return("test_pepper")
result = described_class.hash_function("test_input")
expected = OpenSSL::HMAC.hexdigest("SHA256", "test_pepper", "test_input")
expect(result).to eq(expected)
end
end
describe "#find_by_plaintext_value with legacy token" do
let(:user) { create(:user) }
let(:plain_value) { "plain_token_value" }
let(:legacy_hash) { described_class.legacy_hash_function(plain_value) }
let(:new_hash) { described_class.hash_function(plain_value) }
let!(:token) do
described_class.create!(user:).tap do |t|
t.update_column(:value, legacy_hash)
end
end
it "finds a token stored with the legacy hash" do
found_token = described_class.find_by_plaintext_value(plain_value)
expect(found_token).to eq(token)
end
it "upgrades the token to use the new hash function" do
described_class.find_by_plaintext_value(plain_value)
token.reload
expect(token.value).to eq(new_hash)
end
it "does not find token with wrong plaintext value" do
expect(described_class.find_by_plaintext_value("wrong_value")).to be_nil
end
end
end