devise-security 0.16.0 → 0.17.0

data/test/integration/test_session_limitable_workflow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestSessionLimitableWorkflow < ActionDispatch::IntegrationTest

data/test/orm/active_record.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.logger = Logger.new(nil)
-case
-when Rails.gem_version >= Gem::Version.new('6.0.0')
-  ActiveRecord::MigrationContext.new(File.expand_path('../../dummy/db/migrate', __FILE__), ActiveRecord::SchemaMigration).migrate
-when Rails.gem_version >= Gem::Version.new('5.2.0')
-  ActiveRecord::MigrationContext.new(File.expand_path('../../dummy/db/migrate', __FILE__)).migrate
-else
-  ActiveRecord::Migrator.migrate(File.expand_path('../../dummy/db/migrate', __FILE__))
+
+if Rails.gem_version >= Gem::Version.new('6.0.0')
+  ActiveRecord::MigrationContext.new(File.expand_path('../dummy/db/migrate', __dir__), ActiveRecord::SchemaMigration).migrate
+elsif Rails.gem_version >= Gem::Version.new('5.2.0')
+  ActiveRecord::MigrationContext.new(File.expand_path('../dummy/db/migrate', __dir__)).migrate
 end
 
 DatabaseCleaner[:active_record].strategy = :transaction

data/test/test_compatibility.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestCompatibility < ActiveSupport::TestCase

data/test/test_complexity_validator.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class PasswordComplexityValidatorTest < Minitest::Test
+class PasswordComplexityValidatorTest < ActiveSupport::TestCase
   class ModelWithPassword
     include ActiveModel::Validations
 
@@ -15,58 +17,265 @@ class PasswordComplexityValidatorTest < Minitest::Test
     ModelWithPassword.clear_validators!
   end
 
+  def create_model(password, opts = {})
+    ModelWithPassword.validates(
+      :password, 'devise_security/password_complexity': opts
+    )
+    ModelWithPassword.new(password)
+  end
+
   def test_with_no_rules_anything_goes
-    assert(ModelWithPassword.new('aaaa').valid?)
+    assert(create_model('aaaa').valid?)
+  end
+
+  def test_allows_blank
+    assert(create_model('', { upper: 1 }).valid?)
+  end
+
+  def test_enforces_uppercase_invalid
+    model = create_model('aaaa', { upper: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least one upper-case letter"] }
+    )
+  end
+
+  def test_enforces_uppercase_valid
+    assert(create_model('Aaaa', { upper: 1 }).valid?)
+  end
+
+  def test_enforces_uppercase_count_invalid
+    model = create_model('Aaaa', { upper: 2 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least 2 upper-case letters"] }
+    )
+  end
+
+  def test_enforces_uppercase_count_valid
+    assert(create_model('AAaa', { upper: 2 }).valid?)
+  end
+
+  def test_enforces_digit_invalid
+    model = create_model('aaaa', { digit: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages, { password: ["must contain at least one digit"] }
+    )
   end
 
-  def test_enforces_uppercase
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { upper: 1 }
-    refute(ModelWithPassword.new('aaaa').valid?)
-    assert(ModelWithPassword.new('Aaaa').valid?)
+  def test_enforces_digit_valid
+    assert(create_model('1aaa', { digit: 1 }).valid?)
   end
 
-  def test_enforces_count
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { upper: 2 }
-    refute(ModelWithPassword.new('Aaaa').valid?)
-    assert(ModelWithPassword.new('AAaa').valid?)
+  def test_enforces_digit_count_invalid
+    model = create_model('1aaa', { digit: 2 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages, { password: ["must contain at least 2 digits"] }
+    )
   end
 
-  def test_enforces_digit
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { digit: 1 }
-    refute(ModelWithPassword.new('aaaa').valid?)
-    assert(ModelWithPassword.new('aaa1').valid?)
+  def test_enforces_digit_count_valid
+    assert(create_model('11aa', { digit: 2 }).valid?)
   end
 
-  def test_enforces_digits
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { digits: 2 }
-    refute(ModelWithPassword.new('aaa1').valid?)
-    assert(ModelWithPassword.new('aa12').valid?)
+  def test_enforces_digits_invalid
+    model = create_model('aaaa', { digits: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages, { password: ["must contain at least one digit"] }
+    )
   end
 
-  def test_enforces_lower
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { lower: 1 }
-    refute(ModelWithPassword.new('AAAA').valid?)
-    assert(ModelWithPassword.new('AAAa').valid?)
+  def test_enforces_digits_valid
+    assert(create_model('1aaa', { digits: 1 }).valid?)
   end
 
-  def test_enforces_symbol
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { symbol: 1 }
-    refute(ModelWithPassword.new('aaaa').valid?)
-    assert(ModelWithPassword.new('aaa!').valid?)
+  def test_enforces_digits_count_invalid
+    model = create_model('1aaa', { digits: 2 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages, { password: ["must contain at least 2 digits"] }
+    )
+  end
+
+  def test_enforces_digits_count_valid
+    assert(create_model('11aa', { digits: 2 }).valid?)
+  end
+
+  def test_enforces_lower_invalid
+    model = create_model('AAAA', { lower: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least one lower-case letter"] }
+    )
   end
 
-  def test_enforces_symbols
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { symbols: 2 }
-    refute(ModelWithPassword.new('aaa!').valid?)
-    assert(ModelWithPassword.new('aa!?').valid?)
+  def test_enforces_lower_valid
+    assert(create_model('aAAA', { lower: 1 }).valid?)
+  end
+
+  def test_enforces_lower_count_invalid
+    model = create_model('aAAA', { lower: 2 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least 2 lower-case letters"] }
+    )
+  end
+
+  def test_enforces_lower_count_valid
+    assert(create_model('aaAA', { lower: 2 }).valid?)
+  end
+
+  def test_enforces_symbol_invalid
+    model = create_model('aaaa', { symbol: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least one punctuation mark or symbol"] }
+    )
   end
 
-  def test_enforces_combination
-    ModelWithPassword.validates :password, 'devise_security/password_complexity': { lower: 1, upper: 1, digit: 1, symbol: 1 }
-    refute(ModelWithPassword.new('abcd').valid?)
-    refute(ModelWithPassword.new('ABCD').valid?)
-    refute(ModelWithPassword.new('1234').valid?)
-    refute(ModelWithPassword.new('$!,*').valid?)
-    assert(ModelWithPassword.new('aB3*').valid?)
+  def test_enforces_symbol_valid
+    assert(create_model('!aaa', { symbol: 1 }).valid?)
+  end
+
+  def test_enforces_symbol_count_invalid
+    model = create_model('!aaa', { symbol: 2 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least 2 punctuation marks or symbols"] }
+    )
+  end
+
+  def test_enforces_symbol_count_valid
+    assert(create_model('!!aa', { symbol: 2 }).valid?)
+  end
+
+  def test_enforces_symbols_invalid
+    model = create_model('aaaa', { symbols: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least one punctuation mark or symbol"] }
+    )
+  end
+
+  def test_enforces_symbols_valid
+    assert(create_model('!aaa', { symbols: 1 }).valid?)
+  end
+
+  def test_enforces_symbols_count_invalid
+    model = create_model('!aaa', { symbols: 2 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      { password: ["must contain at least 2 punctuation marks or symbols"] }
+    )
+  end
+
+  def test_enforces_symbols_count_valid
+    assert(create_model('!!aa', { symbols: 2 }).valid?)
+  end
+
+  def test_enforces_combination_only_lower_invalid
+    model = create_model('aaaa', { lower: 1, upper: 1, digit: 1, symbol: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      {
+        password:
+        [
+          "must contain at least one digit",
+          "must contain at least one punctuation mark or symbol",
+          "must contain at least one upper-case letter"
+        ]
+      }
+    )
+  end
+
+  def test_enforces_combination_only_upper_invalid
+    model = create_model('AAAA', { lower: 1, upper: 1, digit: 1, symbol: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      {
+        password:
+        [
+          "must contain at least one digit",
+          "must contain at least one lower-case letter",
+          "must contain at least one punctuation mark or symbol"
+        ]
+      }
+    )
+  end
+
+  def test_enforces_combination_only_digit_invalid
+    model = create_model('1111', { lower: 1, upper: 1, digit: 1, symbol: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      {
+        password:
+        [
+          "must contain at least one lower-case letter",
+          "must contain at least one punctuation mark or symbol",
+          "must contain at least one upper-case letter"
+        ]
+      }
+    )
+  end
+
+  def test_enforces_combination_only_symbol_invalid
+    model = create_model('!!!!', { lower: 1, upper: 1, digit: 1, symbol: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages,
+      {
+        password:
+        [
+          "must contain at least one digit",
+          "must contain at least one lower-case letter",
+          "must contain at least one upper-case letter"
+        ]
+      }
+    )
+  end
+
+  def test_enforces_combination_some_but_not_all_invalid
+    model = create_model('aAa!', { lower: 1, upper: 1, digit: 1, symbol: 1 })
+
+    assert_not(model.valid?)
+    assert_equal(
+      model.errors.messages, { password: ["must contain at least one digit"] }
+    )
+  end
+
+  def test_enforces_combination_all_valid
+    model = create_model('aA1!', { lower: 1, upper: 1, digit: 1, symbol: 1 })
+
+    assert(model.valid?)
   end
 end

data/test/test_database_authenticatable_patch.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestDatabaseAuthenticatablePatch < ActiveSupport::TestCase
+  def create_user
+    User.create(
+      email: 'bob@microsoft.com',
+      password: 'Password1!',
+      password_confirmation: 'Password1!'
+    ) do |user|
+      user.extend(Devise::Models::DatabaseAuthenticatablePatch)
+    end
+  end
+
+  test 'updates if all params are present and valid' do
+    user = create_user
+
+    assert(
+      user.update_with_password(
+        {
+          current_password: 'Password1!',
+          password: 'Password2!',
+          password_confirmation: 'Password2!'
+        }
+      )
+    )
+  end
+
+  test 'does not update if current_password is missing' do
+    user = create_user
+
+    user.update_with_password(
+      {
+        password: 'Password2!',
+        password_confirmation: 'Password2!'
+      }
+    )
+
+    assert_equal(["Current password can't be blank"], user.errors.full_messages)
+  end
+
+  test 'does not update if current_password is incorrect' do
+    user = create_user
+
+    user.update_with_password(
+      {
+        current_password: 'Password2!',
+        password: 'Password2!',
+        password_confirmation: 'Password2!'
+      }
+    )
+
+    assert_equal(["Current password is invalid"], user.errors.full_messages)
+  end
+
+  test 'does not update if password is missing' do
+    user = create_user
+
+    user.update_with_password(
+      {
+        current_password: 'Password1!',
+        password: '',
+        password_confirmation: 'Password2!'
+      }
+    )
+
+    assert_equal(["Password can't be blank"], user.errors.full_messages)
+  end
+
+  test 'does not update if password is invalid and mismatches confirmation' do
+    user = create_user
+
+    result = user.update_with_password(
+      {
+        current_password: 'Password1!',
+        password: 'f',
+        password_confirmation: 'Password2!'
+      }
+    )
+
+    assert_equal(
+      [
+        "Password confirmation doesn't match Password",
+        'Password is too short (minimum is 7 characters)',
+        'Password must contain at least one digit',
+        'Password must contain at least one upper-case letter'
+      ],
+      user.errors.full_messages
+    )
+  end
+
+  test 'does not update if password is invalid and matches confirmation' do
+    user = create_user
+
+    result = user.update_with_password(
+      {
+        current_password: 'Password1!',
+        password: 'f',
+        password_confirmation: 'f'
+      }
+    )
+
+    assert_equal(
+      [
+        'Password is too short (minimum is 7 characters)',
+        'Password must contain at least one digit',
+        'Password must contain at least one upper-case letter'
+      ],
+      user.errors.full_messages
+    )
+  end
+
+  test 'does not update if password_confirmation is missing' do
+    user = create_user
+
+    user.update_with_password(
+      {
+        current_password: 'Password1!',
+        password: 'Password2!',
+        password_confirmation: ''
+      }
+    )
+
+    assert_equal(
+      ["Password confirmation can't be blank"], user.errors.full_messages
+    )
+  end
+
+  test 'does not update if password_confirmation is mismatched' do
+    user = create_user
+
+    user.update_with_password(
+      {
+        current_password: 'Password1!',
+        password: 'Password2!',
+        password_confirmation: 'Password3!'
+      }
+    )
+
+    assert_equal(
+      ["Password confirmation doesn't match Password"],
+      user.errors.full_messages
+    )
+  end
+end

data/test/test_helper.rb

@@ -3,6 +3,13 @@
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'simplecov'
+
+if ENV['CI']
+  require 'simplecov-lcov'
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+end
+
 SimpleCov.start do
   add_filter 'gemfiles'
   add_filter 'test/dummy/db'
@@ -18,14 +25,6 @@ SimpleCov.start do
   add_group 'Tests', 'test'
 end
 
-if ENV['CI']
-  require 'simplecov'
-  require 'simplecov-lcov'
-  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
-  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
-  SimpleCov.start
-end
-
 require 'pry'
 require 'dummy/config/environment'
 require 'minitest/autorun'

data/test/test_install_generator.rb

@@ -6,7 +6,7 @@ require 'generators/devise_security/install_generator'
 
 class TestInstallGenerator < Rails::Generators::TestCase
   tests DeviseSecurity::Generators::InstallGenerator
-  destination File.expand_path('../tmp', __FILE__)
+  destination File.expand_path('tmp', __dir__)
   setup :prepare_destination
 
   test 'Assert all files are properly created' do

data/test/test_paranoid_verification.rb

@@ -94,7 +94,6 @@ class TestParanoidVerification < ActiveSupport::TestCase
     Devise.paranoid_code_regenerate_after_attempt = original_regenerate
   end
 
-
   test 'by default paranoid code regenerate should have 10 attempts' do
     user = User.new(paranoid_verification_code: 'abcde')
     assert_equal 10, user.paranoid_attempts_remaining

data/test/test_password_archivable.rb

@@ -3,7 +3,6 @@
 require 'test_helper'
 
 class TestPasswordArchivable < ActiveSupport::TestCase
-
   setup do
     Devise.password_archiving_count = 2
   end
@@ -20,7 +19,7 @@ class TestPasswordArchivable < ActiveSupport::TestCase
 
   test 'cannot use same password' do
     user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
-    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password1') }
+    assert_raises(ORMInvalidRecordException) { set_password(user, 'Password1') }
   end
 
   test 'indirectly saving associated user does not cause deprecation warning' do
@@ -43,19 +42,19 @@ class TestPasswordArchivable < ActiveSupport::TestCase
 
     user = User.create! email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
     assert_equal 0, OldPassword.count
-    set_password(user,  'Password2')
+    set_password(user, 'Password2')
     assert_equal 1, OldPassword.count
 
-    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password1') }
-    set_password(user,  'Password3')
+    assert_raises(ORMInvalidRecordException) { set_password(user, 'Password1') }
+    set_password(user, 'Password3')
     assert_equal 2, OldPassword.count
 
     # rotate first password out of archive
-    assert set_password(user,  'Password4')
+    assert set_password(user, 'Password4')
 
     # archive count was 2, so first password should work again
-    assert set_password(user,  'Password1')
-    assert set_password(user,  'Password2')
+    assert set_password(user, 'Password1')
+    assert set_password(user, 'Password2')
   end
 
   test 'the option should be dynamic during runtime' do
@@ -67,10 +66,34 @@ class TestPasswordArchivable < ActiveSupport::TestCase
 
     user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
 
-    assert set_password(user,  'Password2')
+    assert set_password(user, 'Password2')
+
+    assert_raises(ORMInvalidRecordException) { set_password(user, 'Password2') }
+
+    assert_raises(ORMInvalidRecordException) { set_password(user, 'Password1') }
+  end
+
+  test 'default sort orders do not affect archiving' do
+    class ::OldPassword
+      default_scope { order(created_at: :asc) }
+    end
+
+    assert_equal 2, Devise.password_archiving_count
+
+    user = User.create! email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
+    assert_equal 0, OldPassword.count
+    set_password(user, 'Password2')
+    assert_equal 1, OldPassword.count
+
+    assert_raises(ORMInvalidRecordException) { set_password(user, 'Password1') }
+    set_password(user, 'Password3')
+    assert_equal 2, OldPassword.count
 
-    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password2') }
+    # rotate first password out of archive
+    assert set_password(user, 'Password4')
 
-    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password1') }
+    # archive count was 2, so first password should work again
+    assert set_password(user, 'Password1')
+    assert set_password(user, 'Password2')
   end
 end