devise-security 0.12.0 → 0.16.0

data/test/integration/test_password_expirable_workflow.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestPasswordExpirableWorkflow < ActionDispatch::IntegrationTest
+  include IntegrationHelpers
+
+  setup do
+    @user = User.create!(password: 'passWord1',
+                         password_confirmation: 'passWord1',
+                         email: 'bob@microsoft.com',
+                         password_changed_at: 4.months.ago) # the default expiration time is 3.months.ago
+    @user.confirm
+
+    assert @user.valid?
+    assert @user.need_change_password?
+  end
+
+  test 'sign in and change expired password' do
+    sign_in(@user)
+    assert_redirected_to(root_path)
+    follow_redirect!
+    assert_redirected_to(user_password_expired_path)
+    # @note This is not the same controller used by Devise for password changes
+    put '/users/password_expired', params: {
+      user: {
+        current_password: 'passWord1',
+        password: 'Password12345!',
+        password_confirmation: 'Password12345!',
+      },
+    }
+    assert_redirected_to(root_path)
+    @user.reload
+    assert_not @user.need_change_password?
+  end
+
+  test 'sign in and password is updated before redirect completes' do
+    sign_in(@user)
+    assert_redirected_to(root_path)
+
+    # simulates an external process updating the password
+    @user.update(password_changed_at: Time.zone.now)
+    assert_not @user.need_change_password?
+
+    follow_redirect!
+    assert_response :success
+
+    # if the password is expired at this point they will be redirected to the
+    # password change controller.
+    get root_path
+    assert_response :success
+  end
+end

data/test/integration/test_session_limitable_workflow.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class TestSessionLimitableWorkflow < ActionDispatch::IntegrationTest
+  include IntegrationHelpers
+
+  setup do
+    @user = User.create!(password: 'passWord1',
+                         password_confirmation: 'passWord1',
+                         email: 'bob@microsoft.com')
+    @user.confirm
+  end
+
+  test 'failed login' do
+    assert_nil @user.unique_session_id
+
+    open_session do |session|
+      failed_sign_in(@user, session)
+      session.assert_response(:success)
+      assert_equal session.flash[:alert], I18n.t('devise.failure.invalid', authentication_keys: 'Email')
+      assert_nil @user.reload.unique_session_id
+    end
+  end
+
+  test 'successful login' do
+    assert_nil @user.unique_session_id
+
+    open_session do |session|
+      sign_in(@user, session)
+      session.assert_redirected_to '/'
+      session.get widgets_path
+      session.assert_response(:success)
+      assert_equal session.response.body, 'success'
+      assert_not_nil @user.reload.unique_session_id
+    end
+  end
+
+  test 'session is logged out when another session is created' do
+    first_session = open_session
+    second_session = open_session
+    unique_session_id = nil
+
+    first_session.tap do |session|
+      sign_in(@user, session)
+      session.assert_redirected_to '/'
+      session.get widgets_path
+      session.assert_response(:success)
+      assert_equal session.response.body, 'success'
+      unique_session_id = @user.reload.unique_session_id
+      assert_not_nil unique_session_id
+    end
+
+    second_session.tap do |session|
+      sign_in(@user, session)
+      session.assert_redirected_to '/'
+      session.get widgets_path
+      session.assert_response(:success)
+      assert_equal session.response.body, 'success'
+      assert_not_equal unique_session_id, @user.reload.unique_session_id
+    end
+
+    first_session.tap do |session|
+      session.get widgets_path
+      session.assert_redirected_to new_user_session_path
+      assert_equal session.flash[:alert], I18n.t('devise.failure.session_limited')
+    end
+  end
+end

data/test/orm/active_record.rb

@@ -0,0 +1,15 @@
+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__))
+end
+
+DatabaseCleaner[:active_record].strategy = :transaction
+ORMInvalidRecordException = ActiveRecord::RecordInvalid

data/test/orm/mongoid.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'mongoid/version'
+require 'database_cleaner-mongoid'
+
+Mongoid.configure do |config|
+  config.load!('test/support/mongoid.yml', Rails.env)
+  config.use_utc = true
+  config.include_root_in_json = true
+end
+
+DatabaseCleaner[:mongoid].strategy = :deletion
+ORMInvalidRecordException = Mongoid::Errors::Validations

data/test/support/integration_helpers.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module IntegrationHelpers
+  # login the user.  This will exercise all the Warden Hooks
+  # @param user [User]
+  # @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,
+      },
+    }
+  end
+
+  # attempt to login the user with a bad password. This will exercise all the Warden Hooks
+  # @param user [User]
+  # @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',
+      },
+    }
+  end
+end

data/test/support/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  clients:
+    default:
+      database: devise-test-suite
+      hosts:
+        - localhost:<%= ENV.fetch('MONGODB_PORT', '27017') %>

data/test/test_compatibility.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class TestCompatibility < ActiveSupport::TestCase
+  test 'can access ActiveRecord namespace' do
+    skip unless DEVISE_ORM == :active_record
+    assert_nothing_raised { User.new.some_method_calling_active_record }
+  end
+
+  test 'can access Mongoid namespace' do
+    skip unless DEVISE_ORM == :mongoid
+    assert_nothing_raised { User.new.some_method_calling_mongoid }
+  end
+end

data/test/test_complexity_validator.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class PasswordComplexityValidatorTest < Minitest::Test
+  class ModelWithPassword
+    include ActiveModel::Validations
+
+    attr_reader :password
+
+    def initialize(password)
+      @password = password
+    end
+  end
+
+  def setup
+    ModelWithPassword.clear_validators!
+  end
+
+  def test_with_no_rules_anything_goes
+    assert(ModelWithPassword.new('aaaa').valid?)
+  end
+
+  def test_enforces_uppercase
+    ModelWithPassword.validates :password, 'devise_security/password_complexity': { upper: 1 }
+    refute(ModelWithPassword.new('aaaa').valid?)
+    assert(ModelWithPassword.new('Aaaa').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?)
+  end
+
+  def test_enforces_digit
+    ModelWithPassword.validates :password, 'devise_security/password_complexity': { digit: 1 }
+    refute(ModelWithPassword.new('aaaa').valid?)
+    assert(ModelWithPassword.new('aaa1').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?)
+  end
+
+  def test_enforces_lower
+    ModelWithPassword.validates :password, 'devise_security/password_complexity': { lower: 1 }
+    refute(ModelWithPassword.new('AAAA').valid?)
+    assert(ModelWithPassword.new('AAAa').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?)
+  end
+
+  def test_enforces_symbols
+    ModelWithPassword.validates :password, 'devise_security/password_complexity': { symbols: 2 }
+    refute(ModelWithPassword.new('aaa!').valid?)
+    assert(ModelWithPassword.new('aa!?').valid?)
+  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?)
+  end
+end

data/test/test_helper.rb

@@ -1,20 +1,53 @@
+# frozen_string_literal: true
+
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'simplecov'
-require 'coveralls'
-Coveralls.wear!
+SimpleCov.start do
+  add_filter 'gemfiles'
+  add_filter 'test/dummy/db'
+  add_group 'ActiveRecord', 'active_record'
+  add_group 'Expirable', /(?<!password_)expirable/
+  add_group 'Mongoid', 'mongoid'
+  add_group 'Paranoid Verifiable', 'paranoid_verification'
+  add_group 'Password Archivable', /password_archivable|old_password/
+  add_group 'Password Expirable', /password_expirable|password_expired/
+  add_group 'Secure Validateable', 'secure_validatable'
+  add_group 'Security Questionable', 'security_question'
+  add_group 'Session Limitable', 'session_limitable'
+  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'
 require 'rails/test_help'
 require 'devise-security'
+require 'database_cleaner'
+require "orm/#{DEVISE_ORM}"
 
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Base.logger = Logger.new(nil)
-ActiveRecord::Migrator.migrate(File.expand_path('../dummy/db/migrate', __FILE__))
+# Controller testing is the way that Devise itself tests the functionality of
+# controller, even though it has been deprecated in favor of request tests.
+require 'rails-controller-testing'
+Rails::Controller::Testing.install
+require 'support/integration_helpers'
 
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-SimpleCov.start do
-  add_filter 'test/dummy'
-  add_filter 'gemfiles'
+class Minitest::Test
+  def before_setup
+    DatabaseCleaner.start
+  end
+
+  def after_teardown
+    DatabaseCleaner.clean
+  end
 end
+
+DatabaseCleaner.clean

data/test/test_install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'rails/generators/test_case'
 require 'generators/devise_security/install_generator'
@@ -9,8 +11,23 @@ class TestInstallGenerator < Rails::Generators::TestCase
 
   test 'Assert all files are properly created' do
     run_generator
-    assert_file 'config/initializers/devise-security.rb'
-    assert_file 'config/locales/devise.security_extension.en.yml'
+    assert_file 'config/initializers/devise_security.rb'
+    assert_file 'config/locales/devise.security_extension.by.yml'
+    assert_file 'config/locales/devise.security_extension.cs.yml'
     assert_file 'config/locales/devise.security_extension.de.yml'
+    assert_file 'config/locales/devise.security_extension.en.yml'
+    assert_file 'config/locales/devise.security_extension.es.yml'
+    assert_file 'config/locales/devise.security_extension.fa.yml'
+    assert_file 'config/locales/devise.security_extension.fr.yml'
+    assert_file 'config/locales/devise.security_extension.hi.yml'
+    assert_file 'config/locales/devise.security_extension.it.yml'
+    assert_file 'config/locales/devise.security_extension.ja.yml'
+    assert_file 'config/locales/devise.security_extension.nl.yml'
+    assert_file 'config/locales/devise.security_extension.pt.yml'
+    assert_file 'config/locales/devise.security_extension.ru.yml'
+    assert_file 'config/locales/devise.security_extension.tr.yml'
+    assert_file 'config/locales/devise.security_extension.uk.yml'
+    assert_file 'config/locales/devise.security_extension.zh_CN.yml'
+    assert_file 'config/locales/devise.security_extension.zh_TW.yml'
   end
 end

data/test/test_paranoid_verification.rb

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

data/test/test_password_archivable.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestPasswordArchivable < ActiveSupport::TestCase
+
   setup do
     Devise.password_archiving_count = 2
   end
@@ -17,7 +20,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(ActiveRecord::RecordInvalid) { set_password(user,  'Password1') }
+    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password1') }
   end
 
   test 'indirectly saving associated user does not cause deprecation warning' do
@@ -35,17 +38,15 @@ class TestPasswordArchivable < ActiveSupport::TestCase
     assert_equal 0, OldPassword.count
   end
 
-  test 'cannot use archived passwords' do
+  test 'cannot reuse archived passwords' do
     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(ActiveRecord::RecordInvalid) { set_password(user,  'Password1') }
-
+    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password1') }
     set_password(user,  'Password3')
     assert_equal 2, OldPassword.count
 
@@ -68,8 +69,8 @@ class TestPasswordArchivable < ActiveSupport::TestCase
 
     assert set_password(user,  'Password2')
 
-    assert_raises(ActiveRecord::RecordInvalid) { set_password(user,  'Password2') }
+    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password2') }
 
-    assert_raises(ActiveRecord::RecordInvalid) { set_password(user,  'Password1') }
+    assert_raises(ORMInvalidRecordException) { set_password(user,  'Password1') }
   end
 end

data/test/test_password_expirable.rb

@@ -1,32 +1,95 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class TestPasswordArchivable < ActiveSupport::TestCase
   setup do
-    Devise.expire_password_after = 2.month
+    Devise.expire_password_after = 2.months
   end
 
   teardown do
     Devise.expire_password_after = 90.days
   end
 
-  test 'password expires' do
+  test 'does nothing if disabled' do
+    Devise.expire_password_after = false
     user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
     refute user.need_change_password?
+    refute user.password_expired?
+    user.need_change_password!
+    refute user.need_change_password?
+    refute user.password_expired?
+  end
 
-    user.update(password_changed_at: Time.now.ago(3.month))
+  test 'password change can be requested' do
+    Devise.expire_password_after = true
+    user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
+    refute user.need_change_password?
+    refute user.password_expired?
+    refute user.password_change_requested?
+    user.need_change_password!
     assert user.need_change_password?
+    refute user.password_expired? # it's not too old because it's not set at all
+    assert user.password_change_requested?
   end
 
-  test 'override expire after at runtime' do
+  test 'password expires' do
+    user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
+    refute user.need_change_password?
+    refute user.password_expired?
+    refute user.password_too_old?
+    user.update(password_changed_at: Time.now.ago(3.months))
+    assert user.password_too_old?
+    assert user.need_change_password?
+    assert user.password_expired?
+    refute user.password_change_requested?
+  end
+
+  test 'saving a record records the time the password was changed' do
     user = User.new email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
+    assert user.password_changed_at.nil?
+    refute user.password_change_requested?
+    refute user.password_expired?
+    user.save
+    assert user.password_changed_at.present?
+    refute user.password_change_requested?
+    refute user.password_expired?
+  end
+
+  test 'updating a record updates the time the password was changed if the password is changed' do
+    user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
+    user.update(password_changed_at: Time.now.ago(3.months))
+    original_password_changed_at = user.password_changed_at
+    user.expire_password!
+    assert user.password_change_requested?
+    user.password = "NewPassword1"
+    user.password_confirmation = "NewPassword1"
+    user.save
+    assert user.password_changed_at > original_password_changed_at
+    refute user.password_change_requested?
+  end
+
+  test 'updating a record does not updates the time the password was changed if the password was not changed' do
+    user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
+    user.expire_password!
+    assert user.password_change_requested?
+    user.save
+    refute user.previous_changes.key?(:password_changed_at)
+    assert user.password_change_requested?
+  end
+
+  test 'override expire after at runtime' do
+    user = User.create email: 'bob@microsoft.com', password: 'Password1', password_confirmation: 'Password1'
     user.instance_eval do
       def expire_password_after
-        4.month
+        4.months
       end
     end
-    user.password_changed_at = Time.now.ago(3.month)
+    user.password_changed_at = Time.now.ago(3.months)
     refute user.need_change_password?
-    user.password_changed_at = Time.now.ago(5.month)
+    refute user.password_expired?
+    user.password_changed_at = Time.now.ago(5.months)
     assert user.need_change_password?
+    assert user.password_expired?
   end
 end