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

@@ -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,69 @@
+# frozen_string_literal: true
+
+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('success', session.response.body)
+      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('success', session.response.body)
+      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('success', session.response.body)
+      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 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+
+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
+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,35 @@
+# 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,15 @@
+# frozen_string_literal: true
+
+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,282 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class PasswordComplexityValidatorTest < ActiveSupport::TestCase
+  class ModelWithPassword
+    include ActiveModel::Validations
+
+    attr_reader :password
+
+    def initialize(password)
+      @password = password
+    end
+  end
+
+  def setup
+    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(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_digit_valid
+    assert(create_model('1aaa', { digit: 1 }).valid?)
+  end
+
+  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_count_valid
+    assert(create_model('11aa', { digit: 2 }).valid?)
+  end
+
+  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_digits_valid
+    assert(create_model('1aaa', { digits: 1 }).valid?)
+  end
+
+  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_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_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