aboutsummaryrefslogtreecommitdiffstats
path: root/activemodel/lib/active_model/secure_password.rb
blob: 06af18dfd1653ec4c16e171ad0818bba2f6b2548 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
require 'active_support/core_ext/object/blank'
require 'bcrypt'

module ActiveModel
  module SecurePassword
    extend ActiveSupport::Concern

    module ClassMethods
      # Adds methods to set and authenticate against a BCrypt password.
      # This mechanism requires you to have a password_digest attribute.
      #
      # Validations for presence of password, confirmation of password (using a "password_confirmation" attribute),
      # and strength of password (at least 6 chars, not "password", etc) are automatically added.
      # You can add more validations by hand if need be.
      #
      # Example using Active Record (which automatically includes ActiveModel::SecurePassword):
      #
      #   # Schema: User(name:string, password_digest:string)
      #   class User < ActiveRecord::Base
      #     has_secure_password
      #   end
      #
      #   user = User.new(:name => "david", :password => "secret", :password_confirmation => "nomatch")
      #   user.save                                                      # => false, password not long enough
      #   user.password = "mUc3m00RsqyRe"
      #   user.save                                                      # => false, confirmation doesn't match
      #   user.password_confirmation = "mUc3m00RsqyRe"
      #   user.save                                                      # => true
      #   user.authenticate("notright")                                  # => false
      #   user.authenticate("mUc3m00RsqyRe")                             # => user
      #   User.find_by_name("david").try(:authenticate, "notright")      # => nil
      #   User.find_by_name("david").try(:authenticate, "mUc3m00RsqyRe") # => user
      def has_secure_password
        attr_reader   :password
        attr_accessor :password_confirmation

        attr_protected(:password_digest) if respond_to?(:attr_protected)

        validates_confirmation_of :password
        validates_presence_of     :password_digest
        validate                  :password_must_be_strong
      end

      # Allows you to specify the set of weak passwords that will be validated against
      # if you specify has_secure_password in your model.
      #
      # The default set of weak passwords are:
      #
      #   class User < ActiveRecord::Base
      #     weak_passwords = %w( password qwerty 123456 mypass )
      #   end
      def weak_passwords=(*values)
        @weak_passwords = values.flatten
      end

      # Returns the list of current weak passwords defined.  Defaults to the standard
      # list of 'password', 'qwerty' and '123456'
      #
      #   User.weak_passwords #=> ['password', 'qwerty', '123456']
      def weak_passwords
        @weak_passwords ||= %w( password qwerty 123456 )
      end

    end

    # Returns self if the password is correct, otherwise false.
    def authenticate(unencrypted_password)
      if BCrypt::Password.new(password_digest) == unencrypted_password
        self
      else
        false
      end
    end

    # Encrypts the password into the password_digest attribute.
    def password=(unencrypted_password)
      @password = unencrypted_password
      self.password_digest = BCrypt::Password.create(unencrypted_password)
    end

    private

    def password_must_be_strong
      if password.present?
        errors.add(:password, :too_short, :count => 7) unless password.size > 6
        errors.add(:password, :insecure) if self.class.weak_passwords.include?(password)
      end
    end
  end
end