devise-security 0.16.0 → 0.18.0

data/test/i18n_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks'
+
+class I18nTest < ActiveSupport::TestCase
+  def setup
+    @i18n = I18n::Tasks::BaseTask.new
+    @missing_keys = @i18n.missing_keys
+  end
+
+  def test_no_missing_keys
+    assert_empty @missing_keys,
+                 "Missing #{@missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+  end
+
+  def test_no_inconsistent_interpolations
+    inconsistent_interpolations = @i18n.inconsistent_interpolations
+    error_message = "#{inconsistent_interpolations.leaves.count} i18n keys have inconsistent interpolations.\n" \
+                    "Please run `i18n-tasks check-consistent-interpolations' to show them"
+    assert_empty inconsistent_interpolations, error_message
+  end
+end

data/test/integration/test_paranoid_verification_code_workflow.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestParanoidVerificationCodeWorkflow < ActionDispatch::IntegrationTest
+  include IntegrationHelpers
+
+  setup do
+    @user = User.create!(
+      password: 'passWord1',
+      password_confirmation: 'passWord1',
+      email: 'bob@microsoft.com',
+      paranoid_verification_code: 'cookies'
+    ) # the default verification code is nil
+    @user.confirm
+
+    assert @user.valid?
+    assert @user.need_paranoid_verification?
+  end
+
+  test 'sign in and check paranoid verification code' do
+    sign_in(@user)
+    assert_redirected_to(root_path)
+    follow_redirect!
+    assert_redirected_to(user_paranoid_verification_code_path)
+    # @note This is not the same controller used by Devise for password changes
+    patch '/users/verification_code', params: {
+      user: {
+        paranoid_verification_code: 'cookies'
+      }
+    }
+    assert_redirected_to(root_path)
+    @user.reload
+    assert_not @user.need_paranoid_verification?
+  end
+
+  test 'sign in and paranoid verification code is checked before redirect completes' do
+    sign_in(@user)
+    assert_redirected_to(root_path)
+
+    # simulates an external process verifying the paranoid verification code
+    @user.update(paranoid_verification_code: nil)
+    assert_not @user.need_paranoid_verification?
+
+    follow_redirect!
+    assert_response :success
+
+    # if the paranoid verification code is not empty/nil at this point they will be redirected to the
+    # paranoid verification code change controller.
+    get root_path
+    assert_response :success
+  end
+end

data/test/integration/test_password_expirable_workflow.rb

@@ -26,8 +26,8 @@ class TestPasswordExpirableWorkflow < ActionDispatch::IntegrationTest
       user: {
         current_password: 'passWord1',
         password: 'Password12345!',
-        password_confirmation: 'Password12345!',
-      },
+        password_confirmation: 'Password12345!'
+      }
     }
     assert_redirected_to(root_path)
     @user.reload

data/test/integration/test_session_limitable_workflow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestSessionLimitableWorkflow < ActionDispatch::IntegrationTest
@@ -29,7 +31,7 @@ class TestSessionLimitableWorkflow < ActionDispatch::IntegrationTest
       session.assert_redirected_to '/'
       session.get widgets_path
       session.assert_response(:success)
-      assert_equal session.response.body, 'success'
+      assert_equal('success', session.response.body)
       assert_not_nil @user.reload.unique_session_id
     end
   end
@@ -44,7 +46,7 @@ class TestSessionLimitableWorkflow < ActionDispatch::IntegrationTest
       session.assert_redirected_to '/'
       session.get widgets_path
       session.assert_response(:success)
-      assert_equal session.response.body, 'success'
+      assert_equal('success', session.response.body)
       unique_session_id = @user.reload.unique_session_id
       assert_not_nil unique_session_id
     end
@@ -54,7 +56,7 @@ class TestSessionLimitableWorkflow < ActionDispatch::IntegrationTest
       session.assert_redirected_to '/'
       session.get widgets_path
       session.assert_response(:success)
-      assert_equal session.response.body, 'success'
+      assert_equal('success', session.response.body)
       assert_not_equal unique_session_id, @user.reload.unique_session_id
     end
 

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/support/integration_helpers.rb

@@ -6,12 +6,15 @@ module IntegrationHelpers
   # @param session [ActionDispatch::Integration::Session]
   # @return [void]
   def sign_in(user, session = integration_session)
-    session.post new_user_session_path, params: {
-      user: {
-        email: user.email,
-        password: user.password,
-      },
-    }
+    session.post(
+      new_user_session_path,
+      params: {
+        user: {
+          email: user.email,
+          password: user.password
+        }
+      }
+    )
   end
 
   # attempt to login the user with a bad password. This will exercise all the Warden Hooks
@@ -19,11 +22,14 @@ module IntegrationHelpers
   # @param session [ActionDispatch::Integration::Session]
   # @return [void]
   def failed_sign_in(user, session)
-    session.post new_user_session_path, params: {
-      user: {
-        email: user.email,
-        password: 'bad-password',
-      },
-    }
+    session.post(
+      new_user_session_path,
+      params: {
+        user: {
+          email: user.email,
+          password: 'bad-password'
+        }
+      }
+    )
   end
 end

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,266 @@ 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(
+      { password: ['must contain at least one upper-case letter'] },
+      model.errors.messages
+    )
+  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(
+      { password: ['must contain at least 2 upper-case letters'] },
+      model.errors.messages
+    )
+  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(
+      { password: ['must contain at least one digit'] }, model.errors.messages
+    )
   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(
+      { password: ['must contain at least 2 digits'] }, model.errors.messages
+    )
   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(
+      { password: ['must contain at least one digit'] }, model.errors.messages
+    )
   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(
+      { password: ['must contain at least 2 digits'] }, model.errors.messages
+    )
+  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(
+      { password: ['must contain at least one lower-case letter'] },
+      model.errors.messages
+    )
   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(
+      { password: ['must contain at least 2 lower-case letters'] },
+      model.errors.messages
+    )
+  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(
+      { password: ['must contain at least one punctuation mark or symbol'] },
+      model.errors.messages
+    )
   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(
+      { password: ['must contain at least 2 punctuation marks or symbols'] },
+      model.errors.messages
+    )
+  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(
+      { password: ['must contain at least one punctuation mark or symbol'] },
+      model.errors.messages
+    )
+  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(
+      { password: ['must contain at least 2 punctuation marks or symbols'] },
+      model.errors.messages
+    )
+  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(
+      {
+        password:
+        [
+          'must contain at least one digit',
+          'must contain at least one punctuation mark or symbol',
+          'must contain at least one upper-case letter'
+        ]
+      },
+      model.errors.messages
+    )
+  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(
+      {
+        password:
+        [
+          'must contain at least one digit',
+          'must contain at least one lower-case letter',
+          'must contain at least one punctuation mark or symbol'
+        ]
+      },
+      model.errors.messages
+    )
+  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(
+      {
+        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'
+        ]
+      },
+      model.errors.messages
+    )
+  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(
+      {
+        password:
+        [
+          'must contain at least one digit',
+          'must contain at least one lower-case letter',
+          'must contain at least one upper-case letter'
+        ]
+      },
+      model.errors.messages
+    )
+  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(
+      { password: ['must contain at least one digit'] },
+      model.errors.messages
+    )
+  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
+
+    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
+
+    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