devise-security 0.16.0 → 0.18.0

data/lib/devise-security/hooks/session_limitable.rb

@@ -8,13 +8,13 @@ Warden::Manager.after_set_user except: :fetch do |record, warden, options|
      warden.authenticated?(options[:scope]) &&
      !record.skip_session_limitable?
 
-     if !options[:skip_session_limitable]
+    if !options[:skip_session_limitable]
       unique_session_id = Devise.friendly_token
       warden.session(options[:scope])['unique_session_id'] = unique_session_id
       record.update_unique_session_id!(unique_session_id)
-     else
+    else
       warden.session(options[:scope])['devise.skip_session_limitable'] = true
-     end
+    end
   end
 end
 
@@ -29,7 +29,7 @@ Warden::Manager.after_set_user only: :fetch do |record, warden, options|
      warden.authenticated?(scope) &&
      options[:store] != false
     if record.unique_session_id != warden.session(scope)['unique_session_id'] &&
-       !record.skip_session_limitable? && 
+       !record.skip_session_limitable? &&
        !warden.session(scope)['devise.skip_session_limitable']
       Rails.logger.warn do
         '[devise-security][session_limitable] session id mismatch: '\

data/lib/devise-security/models/compatibility/active_record_patch.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Devise
   module Models
     module Compatibility
-
       class NotPersistedError < ActiveRecord::ActiveRecordError; end
 
       module ActiveRecordPatch
         extend ActiveSupport::Concern
-        unless Devise.activerecord51?
+
+        unless defined?(ActiveRecord) && ActiveRecord.gem_version >= Gem::Version.new("5.1.x")
           # When the record was saved, was the +encrypted_password+ changed?
           # @return [Boolean]
           def saved_change_to_encrypted_password?
@@ -33,7 +35,6 @@ module Devise
         def update_attribute_without_validatons_or_callbacks(name, value)
           update_column(name, value)
         end
-
       end
     end
   end

data/lib/devise-security/models/compatibility/mongoid_patch.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Devise
   module Models
     module Compatibility
-
       class NotPersistedError < Mongoid::Errors::MongoidError; end
 
       module MongoidPatch
@@ -23,7 +24,7 @@ module Devise
         # @param name [Symbol] attribute to update
         # @param value [String] value to set
         def update_attribute_without_validatons_or_callbacks(name, value)
-          set(Hash[*[name, value]])
+          set(Hash[name, value])
         end
       end
     end

data/lib/devise-security/models/database_authenticatable_patch.rb

@@ -5,20 +5,28 @@ module Devise
     module DatabaseAuthenticatablePatch
       def update_with_password(params, *options)
         current_password = params.delete(:current_password)
+        valid_password = valid_password?(current_password)
 
         new_password = params[:password]
         new_password_confirmation = params[:password_confirmation]
 
-        result = if valid_password?(current_password) && new_password.present? && new_password_confirmation.present?
-          update(params, *options)
-        else
-          self.assign_attributes(params, *options)
-          self.valid?
-          self.errors.add(:current_password, current_password.blank? ? :blank : :invalid)
-          self.errors.add(:password, new_password.blank? ? :blank : :invalid)
-          self.errors.add(:password_confirmation, new_password_confirmation.blank? ? :blank : :invalid)
-          false
-        end
+        result = if valid_password && new_password.present? && new_password_confirmation.present?
+                   update(params, *options)
+                 else
+                   assign_attributes(params, *options)
+
+                   if current_password.blank?
+                     errors.add(:current_password, :blank)
+                   elsif !valid_password
+                     errors.add(:current_password, :invalid)
+                   end
+
+                   errors.add(:password, :blank) if new_password.blank?
+
+                   errors.add(:password_confirmation, :blank) if new_password_confirmation.blank?
+
+                   false
+                 end
 
         clean_up_passwords
         result

data/lib/devise-security/models/expirable.rb

@@ -34,9 +34,11 @@ module Devise
       # @return [bool]
       def expired?
         # expired_at set (manually, via cron, etc.)
-        return self.expired_at < Time.now.utc unless self.expired_at.nil?
+        return expired_at < Time.now.utc unless expired_at.nil?
+
         # if it is not set, check the last activity against configured expire_after time range
-        return self.last_activity_at < self.class.expire_after.ago unless self.last_activity_at.nil?
+        return last_activity_at < self.class.expire_after.ago unless last_activity_at.nil?
+
         # if last_activity_at is nil as well, the user has to be 'fresh' and is therefore not expired
         false
       end
@@ -58,13 +60,13 @@ module Devise
       #
       # @return [bool]
       def active_for_authentication?
-        super && !self.expired?
+        super && !expired?
       end
 
       # The message sym, if {#active_for_authentication?} returns +false+. E.g. needed
       # for i18n.
       def inactive_message
-        !self.expired? ? super : :expired
+        !expired? ? super : :expired
       end
 
       module ClassMethods
@@ -80,7 +82,6 @@ module Devise
           all.each do |u|
             u.expire! if u.expired? && u.expired_at.nil?
           end
-          return
         end
 
         # Scope method to collect all expired users since +time+ ago

data/lib/devise-security/models/paranoid_verification.rb

@@ -20,7 +20,7 @@ module Devise
         elsif code == paranoid_verification_code
           attempt = 0
           update_without_password paranoid_verification_code: nil,
-                                  paranoid_verified_at: Time.now,
+                                  paranoid_verified_at: Time.zone.now,
                                   paranoid_verification_attempt: attempt
         else
           update_without_password paranoid_verification_attempt: attempt
@@ -32,7 +32,7 @@ module Devise
       end
 
       def generate_paranoid_code
-        update_without_password paranoid_verification_code: Devise.verification_code_generator.call(),
+        update_without_password paranoid_verification_code: Devise.verification_code_generator.call,
                                 paranoid_verification_attempt: 0
       end
     end

data/lib/devise-security/models/password_archivable.rb

@@ -35,13 +35,13 @@ module Devise
         end
       end
 
-      # validate is the password used in the past
+      # validate if the password was used in the past
       # @return [true] if current password was used previously
       # @return [false] if disabled or not previously used
       def password_archive_included?
         return false unless max_old_passwords.positive?
 
-        old_passwords_including_cur_change = old_passwords.order(created_at: :desc).limit(max_old_passwords).pluck(:encrypted_password)
+        old_passwords_including_cur_change = old_passwords.reorder(created_at: :desc).limit(max_old_passwords).pluck(:encrypted_password)
         old_passwords_including_cur_change << encrypted_password_was # include most recent change in list, but don't save it yet!
         old_passwords_including_cur_change.any? do |old_password|
           # NOTE: we deliberately do not do mass assignment here so that users that
@@ -73,7 +73,7 @@ module Devise
           return true if old_passwords.where(encrypted_password: encrypted_password_was).exists?
 
           old_passwords.create!(encrypted_password: encrypted_password_was) if encrypted_password_was.present?
-          old_passwords.order(created_at: :desc).offset(max_old_passwords).destroy_all
+          old_passwords.reorder(created_at: :desc).offset(max_old_passwords).destroy_all
         else
           old_passwords.destroy_all
         end

data/lib/devise-security/models/secure_validatable.rb

@@ -26,7 +26,7 @@ module Devise
           already_validated_email = false
 
           # validate login in a strict way if not yet validated
-          unless has_uniqueness_validation_of_login?
+          unless uniqueness_validation_of_login?
             validation_condition = "#{login_attribute}_changed?".to_sym
 
             validates login_attribute, uniqueness: {
@@ -44,20 +44,39 @@ module Devise
               validates :email, uniqueness: true, allow_blank: true, if: :email_changed? # check uniq for email ever
             end
 
-            validates :password, presence: true, length: password_length, confirmation: true, if: :password_required?
+            validates_presence_of :password, if: :password_required?
+            validates_confirmation_of :password, if: :password_required?
+
+            validate if: :password_required? do |record|
+              validates_with ActiveModel::Validations::LengthValidator,
+                             attributes: :password,
+                             allow_blank: true,
+                             in: record.password_length
+            end
           end
 
           # extra validations
-          validates :email, email: email_validation if email_validation # see https://github.com/devise-security/devise-security/blob/master/README.md#e-mail-validation
-          validates :password,
-                    'devise_security/password_complexity': password_complexity,
-                    if: :password_required?
+          # see https://github.com/devise-security/devise-security/blob/master/README.md#e-mail-validation
+          validate do |record|
+            if email_validation
+              validates_with(
+                EmailValidator, { attributes: :email }
+              )
+            end
+          end
+
+          validate if: :password_required? do |record|
+            validates_with(
+              record.password_complexity_validator.is_a?(Class) ? record.password_complexity_validator : record.password_complexity_validator.classify.constantize,
+              { attributes: :password }.merge(record.password_complexity)
+            )
+          end
 
           # don't allow use same password
           validate :current_equal_password_validation
 
           # don't allow email to equal password
-          validate :email_not_equal_password_validation unless allow_passwords_equal_to_email
+          validate :email_not_equal_password_validation
         end
       end
 
@@ -67,21 +86,21 @@ module Devise
 
       def current_equal_password_validation
         return if new_record? || !will_save_change_to_encrypted_password? || password.blank?
+
         dummy = self.class.new(encrypted_password: encrypted_password_was).tap do |user|
           user.password_salt = password_salt_was if respond_to?(:password_salt)
         end
-        self.errors.add(:password, :equal_to_current_password) if dummy.valid_password?(password)
+        errors.add(:password, :equal_to_current_password) if dummy.valid_password?(password)
       end
 
       def email_not_equal_password_validation
-        return if password.blank? || (!new_record? && !will_save_change_to_encrypted_password?)
-        dummy = self.class.new.tap do |user|
-          user.password_salt = password_salt if respond_to?(:password_salt)
-          # whether case_insensitive_keys or strip_whitespace_keys include email or not, any
-          # variation of the email should not be a supported password
-          user.password = email.downcase.strip
-        end
-        self.errors.add(:password, :equal_to_email) if dummy.valid_password?(password.downcase.strip)
+        return if allow_passwords_equal_to_email
+
+        return if password.blank? || email.blank? || (!new_record? && !will_save_change_to_encrypted_password?)
+
+        return unless Devise.secure_compare(password.downcase.strip, email.downcase.strip)
+
+        errors.add(:password, :equal_to_email)
       end
 
       protected
@@ -89,6 +108,8 @@ module Devise
       # Checks whether a password is needed or not. For validations only.
       # Passwords are always required if it's a new record, or if the password
       # or confirmation are being set somewhere.
+      #
+      # @return [Boolean]
       def password_required?
         !persisted? || !password.nil? || !password_confirmation.nil?
       end
@@ -97,15 +118,31 @@ module Devise
         true
       end
 
+      delegate(
+        :allow_passwords_equal_to_email,
+        :email_validation,
+        :password_complexity,
+        :password_complexity_validator,
+        :password_length,
+        to: :class
+      )
+
       module ClassMethods
-        Devise::Models.config(self, :password_complexity, :password_length, :email_validation, :allow_passwords_equal_to_email)
+        Devise::Models.config(
+          self,
+          :allow_passwords_equal_to_email,
+          :email_validation,
+          :password_complexity,
+          :password_complexity_validator,
+          :password_length
+        )
 
         private
 
-        def has_uniqueness_validation_of_login?
+        def uniqueness_validation_of_login?
           validators.any? do |validator|
             validator_orm_klass = DEVISE_ORM == :active_record ? ActiveRecord::Validations::UniquenessValidator : ::Mongoid::Validatable::UniquenessValidator
-            validator.kind_of?(validator_orm_klass) && validator.attributes.include?(login_attribute)
+            validator.is_a?(validator_orm_klass) && validator.attributes.include?(login_attribute)
           end
         end
 
@@ -114,7 +151,7 @@ module Devise
         end
 
         def devise_validation_enabled?
-          self.ancestors.map(&:to_s).include? 'Devise::Models::Validatable'
+          ancestors.map(&:to_s).include? 'Devise::Models::Validatable'
         end
       end
     end

data/lib/devise-security/orm/mongoid.rb

@@ -3,5 +3,5 @@
 ActiveSupport.on_load(:mongoid) do
   require 'orm_adapter/adapters/mongoid'
 
-  Mongoid::Document::ClassMethods.send :include, Devise::Models
+  Mongoid::Document::ClassMethods.include(Devise::Models)
 end

data/lib/devise-security/patches.rb

@@ -6,18 +6,24 @@ module DeviseSecurity
     autoload :ControllerSecurityQuestion, 'devise-security/patches/controller_security_question'
 
     class << self
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def apply
-        Devise::PasswordsController.send(:include, Patches::ControllerCaptcha) if Devise.captcha_for_recover || Devise.security_question_for_recover
-        Devise::UnlocksController.send(:include, Patches::ControllerCaptcha) if Devise.captcha_for_unlock || Devise.security_question_for_unlock
-        Devise::ConfirmationsController.send(:include, Patches::ControllerCaptcha) if Devise.captcha_for_confirmation
+        Devise::PasswordsController.include(Patches::ControllerCaptcha) if Devise.captcha_for_recover || Devise.security_question_for_recover
+        Devise::UnlocksController.include(Patches::ControllerCaptcha) if Devise.captcha_for_unlock || Devise.security_question_for_unlock
+        Devise::ConfirmationsController.include(Patches::ControllerCaptcha) if Devise.captcha_for_confirmation
 
-        Devise::PasswordsController.send(:include, Patches::ControllerSecurityQuestion) if Devise.security_question_for_recover
-        Devise::UnlocksController.send(:include, Patches::ControllerSecurityQuestion) if Devise.security_question_for_unlock
-        Devise::ConfirmationsController.send(:include, Patches::ControllerSecurityQuestion) if Devise.security_question_for_confirmation
+        Devise::PasswordsController.include(Patches::ControllerSecurityQuestion) if Devise.security_question_for_recover
+        Devise::UnlocksController.include(Patches::ControllerSecurityQuestion) if Devise.security_question_for_unlock
+        Devise::ConfirmationsController.include(Patches::ControllerSecurityQuestion) if Devise.security_question_for_confirmation
 
-        Devise::RegistrationsController.send(:include, Patches::ControllerCaptcha) if Devise.captcha_for_sign_up
-        Devise::SessionsController.send(:include, Patches::ControllerCaptcha) if Devise.captcha_for_sign_in
+        Devise::RegistrationsController.include(Patches::ControllerCaptcha) if Devise.captcha_for_sign_up
+        Devise::SessionsController.include(Patches::ControllerCaptcha) if Devise.captcha_for_sign_in
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
     end
   end
 end

data/lib/devise-security/routes.rb

@@ -2,17 +2,16 @@
 
 module ActionDispatch::Routing
   class Mapper
-
     protected
 
     # route for handle expired passwords
     def devise_password_expired(mapping, controllers)
-      resource :password_expired, only: [:show, :update], path: mapping.path_names[:password_expired], controller: controllers[:password_expired]
+      resource :password_expired, only: %i[show update], path: mapping.path_names[:password_expired], controller: controllers[:password_expired]
     end
 
     # route for handle paranoid verification
     def devise_verification_code(mapping, controllers)
-      resource :paranoid_verification_code, only: [:show, :update], path: mapping.path_names[:verification_code], controller: controllers[:paranoid_verification_code]
+      resource :paranoid_verification_code, only: %i[show update], path: mapping.path_names[:verification_code], controller: controllers[:paranoid_verification_code]
     end
   end
 end

data/lib/devise-security/validators/password_complexity_validator.rb

@@ -1,35 +1,62 @@
 # frozen_string_literal: true
 
-# Password complexity validator
+# (NIST)[https://pages.nist.gov/800-63-3/sp800-63b.html#appA] does not recommend
+# the use of a password complexity checks because...
+#
+# > Length and complexity requirements beyond those recommended here
+# > significantly increase the difficulty of memorized secrets and increase user
+# > frustration. As a result, users often work around these restrictions in a
+# > way that is counterproductive. Furthermore, other mitigations such as
+# > blacklists, secure hashed storage, and rate limiting are more effective at
+# > preventing modern brute-force attacks. Therefore, no additional complexity
+# > requirements are imposed.
+#
 # Options:
-# - digit:  minimum number of digits in the validated string
-# - digits: minimum number of digits in the validated string
-# - lower:  minimum number of lower-case letters in the validated string
-# - symbol: minimum number of punctuation characters or symbols in the validated string
-# - symbols: minimum number of punctuation characters or symbols in the validated string
-# - upper:  minimum number of upper-case letters in the validated string
+# - `digit | digits`:  minimum number of digits in the validated string. Uses
+#   the `digit` localization key.
+# - `lower`:  minimum number of lower-case letters in the validated string
+# - `symbol | symbols`: minimum number of punctuation characters or symbols in
+#   the validated string. Uses the `symbol` localization key.
+# - `upper`:  minimum number of upper-case letters in the validated string
 class DeviseSecurity::PasswordComplexityValidator < ActiveModel::EachValidator
-  PATTERNS = {
-    digit: /\p{Digit}/,
-    digits: /\p{Digit}/,
-    lower: /\p{Lower}/,
-    symbol: /\p{Punct}|\p{S}/,
-    symbols: /\p{Punct}|\p{S}/,
-    upper: /\p{Upper}/
-  }.freeze
+  # A Hash of the possible valid patterns that can be checked against. The keys
+  # for this Hash are singular symbols corresponding to entries in the
+  # localization files. Override or redefine this method if you want to include
+  # custom patterns (e.g., `letter: /\p{Alpha}/` for all letters).
+  #
+  # @return [Hash<Symbol,Regexp>]
+  def patterns
+    {
+      digit: /\p{Digit}/,
+      lower: /\p{Lower}/,
+      symbol: /\p{Punct}|\p{S}/,
+      upper: /\p{Upper}/
+    }
+  end
 
-  def validate_each(record, attribute, value)
-    active_pattern_keys.each do |key|
-      minimum = [0, options[key].to_i].max
-      pattern = Regexp.new PATTERNS[key]
+  # Validate the complexity of the password. This validation does not check to
+  # ensure the password is not blank. That is the responsibility of other
+  # validations. This validator will also ignore any patterns that are not
+  # explicitly configured to be used or whose minimum limits are less than 1.
+  #
+  # @param record [ActiveModel::Model]
+  # @param attribute [Symbol]
+  # @param password [String]
+  def validate_each(record, attribute, password)
+    return if password.blank?
 
-      unless (value || '').scan(pattern).size >= minimum
-        record.errors.add attribute, :"password_complexity.#{key}", count: minimum
-      end
-    end
-  end
+    options.sort.each do |pattern_name, minimum|
+      normalized_option = pattern_name.to_s.singularize.to_sym
 
-  def active_pattern_keys
-    options.keys & PATTERNS.keys
+      next unless patterns.key?(normalized_option)
+      next unless minimum.positive?
+      next if password.scan(patterns[normalized_option]).size >= minimum
+
+      record.errors.add(
+        attribute,
+        :"password_complexity.#{normalized_option}",
+        count: minimum
+      )
+    end
   end
 end

data/lib/devise-security/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeviseSecurity
-  VERSION = '0.16.0'
+  VERSION = '0.18.0'
 end

data/lib/devise-security.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 DEVISE_ORM = ENV.fetch('DEVISE_ORM', 'active_record').to_sym unless defined?(DEVISE_ORM)
 
-require DEVISE_ORM.to_s if DEVISE_ORM.in? [:active_record, :mongoid]
+require DEVISE_ORM.to_s if DEVISE_ORM.in? %i[active_record mongoid]
 require 'active_support/core_ext/integer'
 require 'active_support/ordered_hash'
 require 'active_support/concern'
@@ -9,15 +10,20 @@ require 'devise'
 
 module Devise
   # Number of seconds that passwords are valid (e.g 3.months)
-  # Disable pasword expiration with +false+
+  # Disable password expiration with +false+
   # Expire only on demand with +true+
   mattr_accessor :expire_password_after
   @@expire_password_after = 3.months
 
-  # Validate password for strongness
+  # Validate password complexity
   mattr_accessor :password_complexity
   @@password_complexity = { digit: 1, lower: 1, symbol: 1, upper: 1 }
 
+  # Define the class used to validate password complexity. Set to a Class or a
+  # string which will be used to determine which class to use.
+  mattr_accessor :password_complexity_validator
+  @@password_complexity_validator = 'devise_security/password_complexity_validator'
+
   # Number of old passwords in archive
   mattr_accessor :password_archiving_count
   @@password_archiving_count = 5

data/lib/generators/devise_security/install_generator.rb

@@ -6,20 +6,18 @@ module DeviseSecurity
     class InstallGenerator < Rails::Generators::Base
       LOCALES = %w[by cs de en es fa fr hi it ja nl pt ru tr uk zh_CN zh_TW].freeze
 
-      source_root File.expand_path('../../templates', __FILE__)
+      source_root File.expand_path('../templates', __dir__)
       desc 'Install the devise security extension'
 
       def copy_initializer
-        template('devise_security.rb',
-                 'config/initializers/devise_security.rb',
-        )
+        template('devise_security.rb', 'config/initializers/devise_security.rb')
       end
 
       def copy_locales
         LOCALES.each do |locale|
           copy_file(
             "../../../config/locales/#{locale}.yml",
-            "config/locales/devise.security_extension.#{locale}.yml",
+            "config/locales/devise.security_extension.#{locale}.yml"
           )
         end
       end

data/lib/generators/templates/devise_security.rb

@@ -7,7 +7,9 @@ Devise.setup do |config|
   # Should the password expire (e.g 3.months)
   # config.expire_password_after = false
 
-  # Need 1 char of A-Z, a-z and 0-9
+  # Need 1 char each of: A-Z, a-z, 0-9, and a punctuation mark or symbol
+  # You may use "digits" in place of "digit" and "symbols" in place of
+  # "symbol" based on your preference
   # config.password_complexity = { digit: 1, lower: 1, symbol: 1, upper: 1 }
 
   # How many passwords to keep in archive
@@ -44,4 +46,7 @@ Devise.setup do |config|
 
   # Allow password to equal the email
   # config.allow_passwords_equal_to_email = false
+
+  # paranoid_verification will regenerate verification code after failed attempt
+  # config.paranoid_code_regenerate_after_attempt = 10
 end