devise-security 0.12.0 → 0.18.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'devise-security/hooks/paranoid_verification'
 
 module Devise
@@ -18,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
@@ -30,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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require_relative 'compatibility'
+require_relative "#{DEVISE_ORM}/old_password"
 
 module Devise
   module Models
@@ -9,7 +12,7 @@ module Devise
       include Devise::Models::DatabaseAuthenticatable
 
       included do
-        has_many :old_passwords, as: :password_archivable, dependent: :destroy
+        has_many :old_passwords, class_name: 'OldPassword', as: :password_archivable, dependent: :destroy
         before_update :archive_password, if: :will_save_change_to_encrypted_password?
         validate :validate_password_archive, if: :password_present?
       end
@@ -32,15 +35,19 @@ 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 > 0
-        old_passwords_including_cur_change = old_passwords.order(:id).reverse_order.limit(max_old_passwords).pluck(:encrypted_password)
+        return false unless max_old_passwords.positive?
+
+        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|
-          self.class.new(encrypted_password: old_password).valid_password?(password)
+          # NOTE: we deliberately do not do mass assignment here so that users that
+          #   rely on `protected_attributes_continued` gem can still use this extension.
+          #   See issue #68
+          self.class.new.tap { |object| object.encrypted_password = old_password }.valid_password?(password)
         end
       end
 
@@ -58,11 +65,15 @@ module Devise
 
       private
 
-      # archive the last password before save and delete all to old passwords from archive
+      # Archive the last password before save and delete all to old passwords from archive
+      # @note we check to see if an old password has already been archived because
+      #   mongoid will keep re-triggering this callback when we add an old password
       def archive_password
-        if max_old_passwords > 0
+        if max_old_passwords.positive?
+          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(:id).reverse_order.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/password_expirable.rb

@@ -1,67 +1,122 @@
+# frozen_string_literal: true
+
 require 'devise-security/hooks/password_expirable'
 
-module Devise
-  module Models
+module Devise::Models
+  # PasswordExpirable makes passwords expire after a configurable amount of
+  # time, or on demand.
+  #
+  # == Configuration
+  # Set +expire_password_after+ to the number of seconds a password is valid for
+  # (example: +3.months+). Setting it to +true+ will allow passwords to be expired
+  # on-demand only, and +false+ disables this feature.
+  #
+  # == Expire On-Demand
+  # This is useful to force users to change passwords for complex business reasons.
+  # Call +need_change_password+ to indicate a record needs a new password.
+  module PasswordExpirable
+    extend ActiveSupport::Concern
 
-    # PasswordExpirable takes care of change password after
-    module PasswordExpirable
-      extend ActiveSupport::Concern
+    included do
+      scope :with_password_change_requested, -> { where(password_changed_at: nil) }
+      scope :without_password_change_requested, -> { where.not(password_changed_at: nil) }
+      scope :with_expired_password, -> { where('password_changed_at is NULL OR password_changed_at < ?', expire_password_after.seconds.ago) }
+      scope :without_expired_password, -> { without_password_change_requested.where('password_changed_at >= ?', expire_password_after.seconds.ago) }
+      before_save :update_password_changed
+    end
 
-      included do
-        before_save :update_password_changed
-      end
+    # Is a password change required?
+    # @return [Boolean]
+    # @return [true] if +password_changed_at+ has not been set or if it is old
+    #   enough based on +expire_password_after+ configuration.
+    def need_change_password?
+      password_change_requested? || password_too_old?
+    end
 
-      # is an password change required?
-      def need_change_password?
-        if expired_password_after_numeric?
-          self.password_changed_at.nil? || self.password_changed_at < self.expire_password_after.seconds.ago
-        else
-          false
-        end
-      end
+    # Clear the +password_changed_at+ field so that the user will be required to
+    # update their password.
+    # @note Saves the record (without validations)
+    # @return [Boolean]
+    def need_change_password!
+      return unless password_expiration_enabled?
 
-      # set a fake datetime so a password change is needed and save the record
-      def need_change_password!
-        if expired_password_after_numeric?
-          need_change_password
-          self.save(validate: false)
-        end
-      end
+      need_change_password
+      save(validate: false)
+    end
+    alias expire_password! need_change_password!
+    alias request_password_change! need_change_password!
 
-      # set a fake datetime so a password change is needed
-      def need_change_password
-        if expired_password_after_numeric?
-          self.password_changed_at = self.expire_password_after.seconds.ago
-        end
+    # Clear the +password_changed_at+ field so that the user will be required to
+    #   update their password.
+    # @note Does not save the record
+    # @return [void]
+    def need_change_password
+      return unless password_expiration_enabled?
 
-        # is date not set it will set default to need set new password next login
-        need_change_password if self.password_changed_at.nil?
+      self.password_changed_at = nil
+    end
+    alias expire_password need_change_password
+    alias request_password_change need_change_password
 
-        self.password_changed_at
-      end
+    # @return [Integer] number of seconds passwords are valid for
+    # @return [true] passwords are expired 'on demand' only.
+    # @return [false] passwords never expire (this feature is disabled)
+    def expire_password_after
+      self.class.expire_password_after
+    end
 
-      def expire_password_after
-        self.class.expire_password_after
-      end
+    # When +password_changed_at+ is set to +NULL+ in the database
+    # the user is required to change their password.  This only happens
+    # on demand or when the column is first added to the table.
+    # @return [Boolean]
+    def password_change_requested?
+      return false unless password_expiration_enabled?
+      return false if new_record?
 
-      private
+      password_changed_at.nil?
+    end
+
+    # Is this password older than the configured expiration timeout?
+    # @return [Boolean]
+    def password_too_old?
+      return false if new_record?
+      return false unless password_expiration_enabled?
+      return false if expire_password_on_demand?
 
-        # is password changed then update password_cahanged_at
-        def update_password_changed
-          self.password_changed_at = Time.now if (self.new_record? || self.encrypted_password_changed?) && !self.password_changed_at_changed?
-        end
+      password_changed_at < expire_password_after.seconds.ago
+    end
+    alias password_expired? password_too_old?
 
-        def expired_password_after_numeric?
-          return @_numeric if defined?(@_numeric)
-          @_numeric ||= self.expire_password_after.is_a?(1.class) ||
-            self.expire_password_after.is_a?(Float)
-        end
+    private
 
-      module ClassMethods
-        ::Devise::Models.config(self, :expire_password_after)
+    # Update +password_changed_at+ for new records and changed passwords.
+    # @note called as a +before_save+ hook
+    def update_password_changed
+      if defined?(will_save_change_to_attribute?)
+        return unless (new_record? || will_save_change_to_encrypted_password?) && !will_save_change_to_password_changed_at?
+      else
+        return unless (new_record? || encrypted_password_changed?) && !password_changed_at_changed?
       end
+
+      self.password_changed_at = Time.zone.now
     end
 
-  end
+    # Enabled if configuration +expire_password_after+ is set to an {Integer},
+    # {Float}, or {true}
+    def password_expiration_enabled?
+      expire_password_after.is_a?(1.class) ||
+        expire_password_after.is_a?(Float) ||
+        expire_password_on_demand?
+    end
+
+    # When +expire_password_after+ is set to +true+ then only expire passwords
+    # on demand.
+    def expire_password_on_demand?
+      expire_password_after.present? && expire_password_after == true
+    end
 
+    module ClassMethods
+      ::Devise::Models.config(self, :expire_password_after)
+    end
+  end
 end

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require_relative 'compatibility'
+require_relative '../validators/password_complexity_validator'
 
 module Devise
   module Models
@@ -23,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: {
@@ -41,15 +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 # use rails_email_validator or similar
-          validates :password, format: { with: password_regex, message: :password_format }, 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
         end
       end
 
@@ -59,10 +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 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
@@ -70,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
@@ -78,14 +118,31 @@ module Devise
         true
       end
 
-      module ClassMethods
-        Devise::Models.config(self, :password_regex, :password_length, :email_validation)
+      delegate(
+        :allow_passwords_equal_to_email,
+        :email_validation,
+        :password_complexity,
+        :password_complexity_validator,
+        :password_length,
+        to: :class
+      )
 
-      private
-        def has_uniqueness_validation_of_login?
+      module ClassMethods
+        Devise::Models.config(
+          self,
+          :allow_passwords_equal_to_email,
+          :email_validation,
+          :password_complexity,
+          :password_complexity_validator,
+          :password_length
+        )
+
+        private
+
+        def uniqueness_validation_of_login?
           validators.any? do |validator|
-            validator.kind_of?(ActiveRecord::Validations::UniquenessValidator) &&
-              validator.attributes.include?(login_attribute)
+            validator_orm_klass = DEVISE_ORM == :active_record ? ActiveRecord::Validations::UniquenessValidator : ::Mongoid::Validatable::UniquenessValidator
+            validator.is_a?(validator_orm_klass) && validator.attributes.include?(login_attribute)
           end
         end
 
@@ -94,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/models/security_questionable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Devise
   module Models
     # SecurityQuestionable is an accessible add-on for visually handicapped people,

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'compatibility'
 require 'devise-security/hooks/session_limitable'
 
 module Devise
@@ -9,13 +12,27 @@ module Devise
     # someone used his credentials to sign in.
     module SessionLimitable
       extend ActiveSupport::Concern
+      include Devise::Models::Compatibility
 
+      # Update the unique_session_id on the model.  This will be checked in
+      # the Warden after_set_user hook in {file:devise-security/hooks/session_limitable}
+      # @param unique_session_id [String]
+      # @return [void]
+      # @raise [Devise::Models::Compatibility::NotPersistedError] if record is unsaved
       def update_unique_session_id!(unique_session_id)
-        self.unique_session_id = unique_session_id
+        raise Devise::Models::Compatibility::NotPersistedError, 'cannot update a new record' unless persisted?
 
-        save(validate: false)
+        update_attribute_without_validatons_or_callbacks(:unique_session_id, unique_session_id).tap do
+          Rails.logger.debug { "[devise-security][session_limitable] unique_session_id=#{unique_session_id}" }
+        end
       end
 
+      # Should session_limitable be skipped for this instance?
+      # @return [Boolean]
+      # @return [false] by default. This can be overridden by application logic as necessary.
+      def skip_session_limitable?
+        false
+      end
     end
   end
 end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ActiveSupport.on_load(:mongoid) do
+  require 'orm_adapter/adapters/mongoid'
+
+  Mongoid::Document::ClassMethods.include(Devise::Models)
+end

data/lib/devise-security/patches/controller_captcha.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseSecurity::Patches
   module ControllerCaptcha
     extend ActiveSupport::Concern

data/lib/devise-security/patches/controller_security_question.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseSecurity::Patches
   module ControllerSecurityQuestion
     extend ActiveSupport::Concern
@@ -7,6 +9,7 @@ module DeviseSecurity::Patches
     end
 
     private
+
     def check_security_question
       # only find via email, not login
       resource = resource_class.find_or_initialize_with_error_by(:email, params[resource_name][:email], :not_found)
@@ -17,4 +20,3 @@ module DeviseSecurity::Patches
     end
   end
 end
-

data/lib/devise-security/patches.rb

@@ -1,21 +1,29 @@
+# frozen_string_literal: true
+
 module DeviseSecurity
   module Patches
     autoload :ControllerCaptcha, 'devise-security/patches/controller_captcha'
     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/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseSecurity
   class Engine < ::Rails::Engine
     ActiveSupport.on_load(:action_controller) do

data/lib/devise-security/routes.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# (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 | 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
+  # 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
+
+  # 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?
+
+    options.sort.each do |pattern_name, minimum|
+      normalized_option = pattern_name.to_s.singularize.to_sym
+
+      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,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseSecurity
-  VERSION = '0.12.0'.freeze
+  VERSION = '0.18.0'
 end