Skip to content
This repository
branch: master
file 122 lines (111 sloc) 5.015 kb
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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
module ActiveModel
  module SecurePassword
    extend ActiveSupport::Concern

    class << self
      attr_accessor :min_cost # :nodoc:
    end
    self.min_cost = false

    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 on create, confirmation of password
      # (using a +password_confirmation+ attribute) are automatically added. If
      # you wish to turn off validations, pass <tt>validations: false</tt> as an
      # argument. You can add more validations by hand if need be.
      #
      # If you don't need the confirmation validation, just don't set any
      # value to the password_confirmation attribute and the validation
      # will not be triggered.
      #
      # You need to add bcrypt (~> 3.1.7) to Gemfile to use #has_secure_password:
      #
      # gem 'bcrypt', '~> 3.1.7'
      #
      # 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: '', password_confirmation: 'nomatch')
      # user.save # => false, password required
      # 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') # => false
      # User.find_by(name: 'david').try(:authenticate, 'mUc3m00RsqyRe') # => user
      def has_secure_password(options = {})
        # Load bcrypt gem only when has_secure_password is used.
        # This is to avoid ActiveModel (and by extension the entire framework)
        # being dependent on a binary library.
        begin
          require 'bcrypt'
        rescue LoadError
          $stderr.puts "You don't have bcrypt installed in your application. Please add it to your Gemfile and run bundle install"
          raise
        end

        attr_reader :password

        include InstanceMethodsOnActivation

        if options.fetch(:validations, true)
          # This ensures the model has a password by checking whether the password_digest
          # is present, so that this works with both new and existing records. However,
          # when there is an error, the message is added to the password attribute instead
          # so that the error message will make sense to the end-user.
          validate do |record|
            record.errors.add(:password, :blank) unless record.password_digest.present?
          end

          validates_confirmation_of :password, if: ->{ password.present? }
        end

        if respond_to?(:attributes_protected_by_default)
          def self.attributes_protected_by_default #:nodoc:
            super + ['password_digest']
          end
        end
      end
    end

    module InstanceMethodsOnActivation
      # Returns +self+ if the password is correct, otherwise +false+.
      #
      # class User < ActiveRecord::Base
      # has_secure_password validations: false
      # end
      #
      # user = User.new(name: 'david', password: 'mUc3m00RsqyRe')
      # user.save
      # user.authenticate('notright') # => false
      # user.authenticate('mUc3m00RsqyRe') # => user
      def authenticate(unencrypted_password)
        BCrypt::Password.new(password_digest) == unencrypted_password && self
      end

      # Encrypts the password into the +password_digest+ attribute, only if the
      # new password is not blank.
      #
      # class User < ActiveRecord::Base
      # has_secure_password validations: false
      # end
      #
      # user = User.new
      # user.password = nil
      # user.password_digest # => nil
      # user.password = 'mUc3m00RsqyRe'
      # user.password_digest # => "$2a$10$4LEA7r4YmNHtvlAvHhsYAeZmk/xeUVtMTYqwIvYY76EW5GUqDiP4."
      def password=(unencrypted_password)
        if unencrypted_password.nil?
          self.password_digest = nil
        elsif unencrypted_password.present?
          @password = unencrypted_password
          cost = ActiveModel::SecurePassword.min_cost ? BCrypt::Engine::MIN_COST : BCrypt::Engine.cost
          self.password_digest = BCrypt::Password.create(unencrypted_password, cost: cost)
        end
      end

      def password_confirmation=(unencrypted_password)
        @password_confirmation = unencrypted_password
      end
    end
  end
end
Something went wrong with that request. Please try again.