devise-security 0.14.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

@@ -2,7 +2,10 @@ require 'active_record'
 
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.logger = Logger.new(nil)
-if Rails.gem_version >= Gem::Version.new('5.2.0')
+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__))

data/test/orm/mongoid.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'mongoid/version'
+require 'database_cleaner-mongoid'
 
 Mongoid.configure do |config|
   config.load!('test/support/mongoid.yml', Rails.env)
@@ -8,5 +9,5 @@ Mongoid.configure do |config|
   config.include_root_in_json = true
 end
 
-DatabaseCleaner[:mongoid].strategy = :truncation
+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

@@ -1,5 +1,5 @@
 test:
-  <%= Mongoid::VERSION.to_i > 4 ? 'clients' : 'sessions' %>:
+  clients:
     default:
       database: devise-test-suite
       hosts:

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

@@ -37,6 +37,12 @@ class PasswordComplexityValidatorTest < Minitest::Test
     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?)
@@ -49,6 +55,12 @@ class PasswordComplexityValidatorTest < Minitest::Test
     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?)

data/test/test_helper.rb

@@ -1,20 +1,29 @@
 # frozen_string_literal: true
 
 ENV['RAILS_ENV'] ||= 'test'
-DEVISE_ORM = ENV.fetch('DEVISE_ORM',  'active_record').to_sym
 
 require 'simplecov'
 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'
-  add_group 'Password Archivable', 'password_archivable'
-  add_group 'Password Expirable', 'password_expirable'
 end
 
 if ENV['CI']
-  require 'coveralls'
-  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-  Coveralls.wear!
+  require 'simplecov'
+  require 'simplecov-lcov'
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+  SimpleCov.start
 end
 
 require 'pry'
@@ -25,6 +34,12 @@ require 'devise-security'
 require 'database_cleaner'
 require "orm/#{DEVISE_ORM}"
 
+# 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'
+
 class Minitest::Test
   def before_setup
     DatabaseCleaner.start

data/test/test_install_generator.rb

@@ -11,13 +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/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_secure_validatable.rb

@@ -82,4 +82,80 @@ class TestSecureValidatable < ActiveSupport::TestCase
     refute user.valid?
     assert_equal DEVISE_ORM == :active_record ? ['Email has already been taken'] : ['Email is already taken'], user.errors.full_messages
   end
+
+  test 'password can not equal email for new user' do
+    msg = 'Password must be different than the email.'
+    user = User.create email: 'bob@microsoft.com', password: 'bob@microsoft.com', password_confirmation: 'bob@microsoft.com'
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal case sensitive version of email for new user' do
+    msg = 'Password must be different than the email.'
+    user = User.create email: 'bob@microsoft.com', password: 'BoB@microsoft.com', password_confirmation: 'BoB@microsoft.com'
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal email with spaces for new user' do
+    msg = 'Password must be different than the email.'
+    user = User.create email: 'bob@microsoft.com', password: 'bob@microsoft.com    ', password_confirmation: 'bob@microsoft.com    '
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal case sensitive version of email with spaces for new user' do
+    msg = 'Password must be different than the email.'
+    user = User.create email: 'bob@microsoft.com', password: '  BoB@microsoft.com   ', password_confirmation: '  BoB@microsoft.com   '
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal email for existing user' do
+    user = User.create email: 'bob@microsoft.com', password: 'pAs5W0rd!Is5e6Ure', password_confirmation: 'pAs5W0rd!Is5e6Ure'
+
+    msg = 'Password must be different than the email.'
+    user.password = 'bob@microsoft.com'
+    user.password_confirmation = 'bob@microsoft.com'
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal case sensitive version of email for existing user' do
+    user = User.create email: 'bob@microsoft.com', password: 'pAs5W0rd!Is5e6Ure', password_confirmation: 'pAs5W0rd!Is5e6Ure'
+
+    msg = 'Password must be different than the email.'
+    user.password = 'BoB@microsoft.com'
+    user.password_confirmation = 'BoB@microsoft.com'
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal email with spaces for existing user' do
+    user = User.create email: 'bob@microsoft.com', password: 'pAs5W0rd!Is5e6Ure', password_confirmation: 'pAs5W0rd!Is5e6Ure'
+
+    msg = 'Password must be different than the email.'
+    user.password = 'bob@microsoft.com     '
+    user.password_confirmation = 'bob@microsoft.com     '
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
+
+  test 'password can not equal case sensitive version of email with spaces for existing user' do
+    user = User.create email: 'bob@microsoft.com', password: 'pAs5W0rd!Is5e6Ure', password_confirmation: 'pAs5W0rd!Is5e6Ure'
+
+    msg = 'Password must be different than the email.'
+    user.password = ' BoB@microsoft.com      '
+    user.password_confirmation = ' BoB@microsoft.com      '
+    refute user.valid?
+    assert_includes(user.errors.full_messages, msg)
+    assert_raises(ORMInvalidRecordException) { user.save! }
+  end
 end

data/test/test_session_limitable.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestSessionLimitable < ActiveSupport::TestCase
+  class ModifiedUser < User
+    def skip_session_limitable?
+      true
+    end
+  end
+
+  test 'check is not skipped by default' do
+    user = User.create email: 'bob@microsoft.com', password: 'password1', password_confirmation: 'password1'
+    assert_equal(false, user.skip_session_limitable?)
+  end
+
+  test 'default check can be overridden by record instance' do
+    modified_user = ModifiedUser.create email: 'bob2@microsoft.com', password: 'password1', password_confirmation: 'password1'
+    assert_equal(true, modified_user.skip_session_limitable?)
+  end
+    
+  class SessionLimitableUser < User
+    devise :session_limitable
+    include ::Mongoid::Mappings if DEVISE_ORM == :mongoid
+  end
+
+  test 'includes Devise::Models::Compatibility' do
+    assert_kind_of(Devise::Models::Compatibility, SessionLimitableUser.new)
+  end
+
+  test '#update_unique_session_id!(value) updates valid record' do
+    user = User.create! password: 'passWord1', password_confirmation: 'passWord1', email: 'bob@microsoft.com'
+    assert user.persisted?
+    assert_nil user.unique_session_id
+    user.update_unique_session_id!('unique_value')
+    user.reload
+    assert_equal user.unique_session_id, 'unique_value'
+  end
+
+  test '#update_unique_session_id!(value) updates invalid record atomically' do
+    user = User.create! password: 'passWord1', password_confirmation: 'passWord1', email: 'bob@microsoft.com'
+    assert user.persisted?
+    user.email = ''
+    assert user.invalid?
+    assert_nil user.unique_session_id
+    user.update_unique_session_id!('unique_value')
+    user.reload
+    assert_equal user.email, 'bob@microsoft.com'
+    assert_equal user.unique_session_id, 'unique_value'
+  end
+
+  test '#update_unique_session_id!(value) raises an exception on an unpersisted record' do
+    user = User.create
+    assert !user.persisted?
+    assert_raises(Devise::Models::Compatibility::NotPersistedError) { user.update_unique_session_id!('unique_value') }
+  end
+end