mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
123bcf5faa
- This class is used to rotate a previously determined value to a new
one before making the comparions.
We use this at Shopify to rotate Basic Auth crendials but I can
imagine other use cases.
The implementation uses the same `Messages::Rotator` module than
the MessageEncryptor/MessageVerifier class so it works exactly the
same way.
You can use it as follow:
```ruby
rotator = ActiveSupport::SecureCompareRotator.new('new_production_value')
rotator.rotate('previous_production_value')
rotator.secure_compare!('previous_production_value')
```
44 lines
1.4 KiB
Ruby
44 lines
1.4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "abstract_unit"
|
|
require "active_support/secure_compare_rotator"
|
|
|
|
class SecureCompareRotatorTest < ActiveSupport::TestCase
|
|
test "#secure_compare! works correctly after rotation" do
|
|
wrapper = ActiveSupport::SecureCompareRotator.new("old_secret")
|
|
wrapper.rotate("new_secret")
|
|
|
|
assert_equal(true, wrapper.secure_compare!("new_secret"))
|
|
end
|
|
|
|
test "#secure_compare! works correctly after multiple rotation" do
|
|
wrapper = ActiveSupport::SecureCompareRotator.new("old_secret")
|
|
wrapper.rotate("new_secret")
|
|
wrapper.rotate("another_secret")
|
|
wrapper.rotate("and_another_one")
|
|
|
|
assert_equal(true, wrapper.secure_compare!("and_another_one"))
|
|
end
|
|
|
|
test "#secure_compare! fails correctly when credential is not part of the rotation" do
|
|
wrapper = ActiveSupport::SecureCompareRotator.new("old_secret")
|
|
wrapper.rotate("new_secret")
|
|
|
|
assert_raises(ActiveSupport::SecureCompareRotator::InvalidMatch) do
|
|
wrapper.secure_compare!("different_secret")
|
|
end
|
|
end
|
|
|
|
test "#secure_compare! calls the on_rotation proc" do
|
|
wrapper = ActiveSupport::SecureCompareRotator.new("old_secret")
|
|
wrapper.rotate("new_secret")
|
|
wrapper.rotate("another_secret")
|
|
wrapper.rotate("and_another_one")
|
|
|
|
@witness = nil
|
|
|
|
assert_changes(:@witness, from: nil, to: true) do
|
|
assert_equal(true, wrapper.secure_compare!("and_another_one", on_rotation: -> { @witness = true }))
|
|
end
|
|
end
|
|
end
|