devise-security 0.12.0 → 0.16.0

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
@@ -45,11 +48,16 @@ module Devise
           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?
+          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?
 
           # 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
         end
       end
 
@@ -65,6 +73,17 @@ module Devise
         self.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)
+      end
+
       protected
 
       # Checks whether a password is needed or not. For validations only.
@@ -79,13 +98,14 @@ module Devise
       end
 
       module ClassMethods
-        Devise::Models.config(self, :password_regex, :password_length, :email_validation)
+        Devise::Models.config(self, :password_complexity, :password_length, :email_validation, :allow_passwords_equal_to_email)
+
+        private
 
-      private
         def has_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.kind_of?(validator_orm_klass) && validator.attributes.include?(login_attribute)
           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.send :include, Devise::Models
+end

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

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

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

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

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/passwords_controller_captcha.rb

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

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

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

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

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

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

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

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

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

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

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

data/lib/devise-security/patches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviseSecurity
   module Patches
     autoload :ControllerCaptcha, 'devise-security/patches/controller_captcha'

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionDispatch::Routing
   class Mapper
 

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Password complexity validator
+# 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
+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
+
+  def validate_each(record, attribute, value)
+    active_pattern_keys.each do |key|
+      minimum = [0, options[key].to_i].max
+      pattern = Regexp.new PATTERNS[key]
+
+      unless (value || '').scan(pattern).size >= minimum
+        record.errors.add attribute, :"password_complexity.#{key}", count: minimum
+      end
+    end
+  end
+
+  def active_pattern_keys
+    options.keys & PATTERNS.keys
+  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.16.0'
 end

data/lib/devise-security.rb

@@ -1,18 +1,22 @@
-require 'active_record'
+# 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 'active_support/core_ext/integer'
 require 'active_support/ordered_hash'
 require 'active_support/concern'
 require 'devise'
 
 module Devise
-
-  # Should the password expire (e.g 3.months)
+  # Number of seconds that passwords are valid (e.g 3.months)
+  # Disable pasword expiration with +false+
+  # Expire only on demand with +true+
   mattr_accessor :expire_password_after
   @@expire_password_after = 3.months
 
   # Validate password for strongness
-  mattr_accessor :password_regex
-  @@password_regex = /(?=.*\d)(?=.*[a-z])(?=.*[A-Z])/
+  mattr_accessor :password_complexity
+  @@password_complexity = { digit: 1, lower: 1, symbol: 1, upper: 1 }
 
   # Number of old passwords in archive
   mattr_accessor :password_archiving_count
@@ -23,7 +27,7 @@ module Devise
   @@deny_old_passwords = true
 
   # enable email validation for :secure_validatable. (true, false, validation_options)
-  # dependency: need an email validator like rails_email_validator
+  # dependency: need an email validator, see https://github.com/devise-security/devise-security/blob/master/README.md#e-mail-validation
   mattr_accessor :email_validation
   @@email_validation = true
 
@@ -75,11 +79,14 @@ module Devise
   # paranoid_verification will regenerate verifacation code after faild attempt
   mattr_accessor :paranoid_code_regenerate_after_attempt
   @@paranoid_code_regenerate_after_attempt = 10
+
+  # Whether to allow passwords that are equal (case insensitive) to the email
+  mattr_accessor :allow_passwords_equal_to_email
+  @@allow_passwords_equal_to_email = false
 end
 
-# an security extension for devise
+# a security extension for devise
 module DeviseSecurity
-  autoload :Schema, 'devise-security/schema'
   autoload :Patches, 'devise-security/patches'
 
   module Controllers
@@ -100,7 +107,6 @@ Devise.add_module :paranoid_verification, controller: :paranoid_verification_cod
 # requires
 require 'devise-security/routes'
 require 'devise-security/rails'
-require 'devise-security/orm/active_record'
-require 'devise-security/models/old_password'
+require "devise-security/orm/#{DEVISE_ORM}" if DEVISE_ORM == :mongoid
 require 'devise-security/models/database_authenticatable_patch'
 require 'devise-security/models/paranoid_verification'

data/lib/generators/devise_security/install_generator.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module DeviseSecurity
   module Generators
     # Generator for Rails to create or append to a Devise initializer.
     class InstallGenerator < Rails::Generators::Base
-      LOCALES = %w[ en de it ]
+      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__)
       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
 

data/lib/generators/templates/devise_security.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+Devise.setup do |config|
+  # ==> Security Extension
+  # Configure security extension for devise
+
+  # Should the password expire (e.g 3.months)
+  # config.expire_password_after = false
+
+  # Need 1 char of A-Z, a-z and 0-9
+  # config.password_complexity = { digit: 1, lower: 1, symbol: 1, upper: 1 }
+
+  # How many passwords to keep in archive
+  # config.password_archiving_count = 5
+
+  # Deny old passwords (true, false, number_of_old_passwords_to_check)
+  # Examples:
+  # config.deny_old_passwords = false # allow old passwords
+  # config.deny_old_passwords = true # will deny all the old passwords
+  # config.deny_old_passwords = 3 # will deny new passwords that matches with the last 3 passwords
+  # config.deny_old_passwords = true
+
+  # enable email validation for :secure_validatable. (true, false, validation_options)
+  # dependency: see https://github.com/devise-security/devise-security/blob/master/README.md#e-mail-validation
+  # config.email_validation = true
+
+  # captcha integration for recover form
+  # config.captcha_for_recover = true
+
+  # captcha integration for sign up form
+  # config.captcha_for_sign_up = true
+
+  # captcha integration for sign in form
+  # config.captcha_for_sign_in = true
+
+  # captcha integration for unlock form
+  # config.captcha_for_unlock = true
+
+  # captcha integration for confirmation form
+  # config.captcha_for_confirmation = true
+
+  # Time period for account expiry from last_activity_at
+  # config.expire_after = 90.days
+
+  # Allow password to equal the email
+  # config.allow_passwords_equal_to_email = false
+end

data/test/{test_captcha_controller.rb → controllers/test_captcha_controller.rb}

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

data/test/controllers/test_password_expired_controller.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class Devise::PasswordExpiredControllerTest < ActionController::TestCase
+  include Devise::Test::ControllerHelpers
+
+  setup do
+    @controller.class.respond_to :json, :xml
+    @request.env['devise.mapping'] = Devise.mappings[:user]
+    @user = User.create!(
+      username: 'hello',
+      email: 'hello@path.travel',
+      password: 'Password4',
+      password_changed_at: 4.months.ago,
+      confirmed_at: 5.months.ago,
+    )
+    assert @user.valid?
+    assert @user.need_change_password?
+
+    sign_in(@user)
+  end
+
+  test 'redirects on show if user not logged in' do
+    sign_out(@user)
+    get :show
+    assert_redirected_to :root
+  end
+
+  test 'redirects on show if user does not need password change' do
+    @user.update(password_changed_at: Time.zone.now)
+    get :show
+    assert_redirected_to :root
+  end
+
+  test 'should render show' do
+    get :show
+    assert_includes @response.body, 'Renew your password'
+  end
+
+  test 'redirects on update if user not logged in' do
+    sign_out(@user)
+    put :update
+    assert_redirected_to :root
+  end
+
+  test 'redirects on update if user does not need password change' do
+    @user.update(password_changed_at: Time.zone.now)
+    put :update
+    assert_redirected_to :root
+  end
+
+  test 'update password with default format' do
+    put :update,
+        params: {
+          user: {
+            current_password: 'Password4',
+            password: 'Password5',
+            password_confirmation: 'Password5',
+          },
+        }
+    assert_redirected_to root_path
+    assert_equal response.media_type, 'text/html'
+  end
+
+  test 'password confirmation does not match' do
+    put :update,
+        params: {
+          user: {
+            current_password: 'Password4',
+            password: 'Password5',
+            password_confirmation: 'Password6',
+          },
+        }
+
+    assert_response :success
+    assert_template :show
+    assert_equal response.media_type, 'text/html'
+  end
+
+  test 'update password using JSON format' do
+    put :update,
+        format: :json,
+        params: {
+          user: {
+            current_password: 'Password4',
+            password: 'Password5',
+            password_confirmation: 'Password5',
+          },
+        }
+    assert_response 204
+    assert_equal root_url, response.location
+    assert_nil response.media_type, 'No Content-Type header should be set for No Content response'
+  end
+
+  test 'update password using XML format' do
+    put :update,
+        format: :xml,
+        params: {
+          user: {
+            current_password: 'Password4',
+            password: 'Password5',
+            password_confirmation: 'Password5',
+          },
+        }
+    assert_response 204
+    assert_equal root_url, response.location
+    assert_nil response.media_type, 'No Content-Type header should be set for No Content response'
+  end
+end

data/test/controllers/test_security_question_controller.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestWithSecurityQuestion < ActionController::TestCase
+  include Devise::Test::ControllerHelpers
+  tests SecurityQuestion::UnlocksController
+
+  setup do
+    @user = SecurityQuestionUser.create!(username: 'hello', email: 'hello@microsoft.com',
+                                         password: 'A1234567z!', security_question_answer: 'Right Answer')
+    @user.lock_access!
+    assert @user.locked_at.present?
+    @request.env['devise.mapping'] = Devise.mappings[:security_question_user]
+  end
+
+  test 'When security question is enabled, it is inserted correctly' do
+    post :create, params: {
+      security_question_user: {
+        email: @user.email,
+      }, security_question_answer: 'wrong answer'
+    }
+    assert_equal I18n.t('devise.invalid_security_question'), flash[:alert]
+    assert_redirected_to new_security_question_user_unlock_path
+  end
+
+  test 'When security_question is valid, it runs as normal' do
+    post :create, params: {
+      security_question_user: {
+        email: @user.email,
+      }, security_question_answer: @user.security_question_answer
+    }
+
+    assert_equal I18n.t('devise.unlocks.send_instructions'), flash[:notice]
+    assert_redirected_to new_security_question_user_session_path
+  end
+end
+
+class TestWithoutSecurityQuestion < ActionController::TestCase
+  include Devise::Test::ControllerHelpers
+  tests Devise::UnlocksController
+
+  setup do
+    @user = User.create(username: 'hello', email: 'hello@path.travel',
+                        password: '1234', security_question_answer: 'Right Answer')
+    @user.lock_access!
+    @request.env['devise.mapping'] = Devise.mappings[:user]
+  end
+
+  test 'When security question is not enabled it is not inserted' do
+    post :create, params: {
+      user: {
+        email: @user.email,
+      },
+    }
+
+    assert_equal I18n.t('devise.unlocks.send_instructions'), flash[:notice]
+    assert_redirected_to new_user_session_path
+  end
+end

data/test/dummy/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+// = link_tree ../images
+// = link_directory ../javascripts .js
+// = link_directory ../stylesheets .css

data/test/dummy/app/controllers/application_controller.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
 end

data/test/dummy/app/controllers/captcha/sessions_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Captcha::SessionsController < Devise::SessionsController
   include DeviseSecurity::Patches::ControllerCaptcha
 end

data/test/dummy/app/controllers/security_question/unlocks_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SecurityQuestion::UnlocksController < Devise::UnlocksController
   include DeviseSecurity::Patches::ControllerSecurityQuestion
 end

data/test/dummy/app/controllers/widgets_controller.rb

@@ -0,0 +1,6 @@
+class WidgetsController < ApplicationController
+  before_action :authenticate_user!
+  def show
+    render plain: 'success'
+  end
+end

data/test/dummy/app/models/application_record.rb

@@ -1,3 +1,11 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
+# frozen_string_literal: true
+
+if DEVISE_ORM == :active_record
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+else
+  class ApplicationRecord
+    include Mongoid::Document
+  end
 end

data/test/dummy/app/models/application_user_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+if DEVISE_ORM == :active_record
+  class ApplicationUserRecord < ActiveRecord::Base
+    self.table_name = 'users'
+  end
+else
+  class ApplicationUserRecord
+    include Mongoid::Document
+    store_in collection: 'users'
+  end
+end

data/test/dummy/app/models/captcha_user.rb

@@ -1,5 +1,10 @@
-class CaptchaUser < ActiveRecord::Base
-  self.table_name = 'users'
+# frozen_string_literal: true
+
+class CaptchaUser < ApplicationUserRecord
   devise :database_authenticatable, :password_archivable,
          :paranoid_verification, :password_expirable
+  if DEVISE_ORM == :mongoid
+    require './test/dummy/app/models/mongoid/mappings'
+    include ::Mongoid::Mappings
+  end
 end