module Devise::Models::DatabaseAuthenticatable

Authenticatable Module, responsible for encrypting password and validating authenticity of a user while signing in.

Options

DatabaseAuthenticable adds the following options to devise_for:

* +pepper+: a random string used to provide a more secure hash. Use
  `rake secret` to generate new keys.

* +stretches+: the cost given to bcrypt.

Examples

User.find(1).valid_password?('password123')         # returns true/false

Public Class Methods

required_fields(klass) click to toggle source
# File lib/devise/models/database_authenticatable.rb, line 35
def self.required_fields(klass)
  [:encrypted_password] + klass.authentication_keys
end

Public Instance Methods

after_database_authentication() click to toggle source

A callback initiated after successfully authenticating. This can be used to insert your own logic that is only run after the user successfully authenticates.

Example:

def after_database_authentication
  self.update_attribute(:invite_code, nil)
end
# File lib/devise/models/database_authenticatable.rb, line 132
def after_database_authentication
end
authenticatable_salt() click to toggle source

A reliable way to expose the salt regardless of the implementation.

# File lib/devise/models/database_authenticatable.rb, line 136
def authenticatable_salt
  encrypted_password[0,29] if encrypted_password
end
clean_up_passwords() click to toggle source

Set password and password confirmation to nil

# File lib/devise/models/database_authenticatable.rb, line 54
def clean_up_passwords
  self.password = self.password_confirmation = nil
end
destroy_with_password(current_password) click to toggle source

Destroy record when :current_password matches, otherwise returns error on :current_password. It also automatically rejects :current_password if it is blank.

# File lib/devise/models/database_authenticatable.rb, line 110
def destroy_with_password(current_password)
  result = if valid_password?(current_password)
    destroy
  else
    self.valid?
    self.errors.add(:current_password, current_password.blank? ? :blank : :invalid)
    false
  end

  result
end
password=(new_password) click to toggle source

Generates password encryption based on the given value.

# File lib/devise/models/database_authenticatable.rb, line 40
def password=(new_password)
  @password = new_password
  self.encrypted_password = password_digest(@password) if @password.present?
end
update_with_password(params, *options) click to toggle source

Update record attributes when :current_password matches, otherwise returns error on :current_password.

This method also rejects the password field if it is blank (allowing users to change relevant information like the e-mail without changing their password). In case the password field is rejected, the confirmation is also rejected as long as it is also blank.

# File lib/devise/models/database_authenticatable.rb, line 65
def update_with_password(params, *options)
  current_password = params.delete(:current_password)

  if params[:password].blank?
    params.delete(:password)
    params.delete(:password_confirmation) if params[:password_confirmation].blank?
  end

  result = if valid_password?(current_password)
    update_attributes(params, *options)
  else
    self.assign_attributes(params, *options)
    self.valid?
    self.errors.add(:current_password, current_password.blank? ? :blank : :invalid)
    false
  end

  clean_up_passwords
  result
end
update_without_password(params, *options) click to toggle source

Updates record attributes without asking for the current password. Never allows a change to the current password. If you are using this method, you should probably override this method to protect other attributes you would not like to be updated without a password.

Example:

def update_without_password(params, *options)
  params.delete(:email)
  super(params)
end
# File lib/devise/models/database_authenticatable.rb, line 98
def update_without_password(params, *options)
  params.delete(:password)
  params.delete(:password_confirmation)

  result = update_attributes(params, *options)
  clean_up_passwords
  result
end
valid_password?(password) click to toggle source

Verifies whether an password (ie from sign in) is the user password.

# File lib/devise/models/database_authenticatable.rb, line 46
def valid_password?(password)
  return false if encrypted_password.blank?
  bcrypt   = ::BCrypt::Password.new(encrypted_password)
  password = ::BCrypt::Engine.hash_secret("#{password}#{self.class.pepper}", bcrypt.salt)
  Devise.secure_compare(password, encrypted_password)
end

Protected Instance Methods

password_digest(password) click to toggle source

Digests the password using bcrypt. Custom encryption should override this method to apply their own algorithm.

See github.com/plataformatec/devise-encryptable for examples of other encryption engines.

# File lib/devise/models/database_authenticatable.rb, line 147
def password_digest(password)
  Devise.bcrypt(self.class, password)
end