Spec-Zone.ru › Ruby on Rails 6.0

модуль ActiveModel::SecurePassword::ClassMethods

Включенные модули:
ActiveModel::Validations

Публичные методы экземпляров

has_secure_password(attribute = :password, validations: true) Показать исходный код
# File activemodel/lib/active_model/secure_password.rb, line 61
def has_secure_password(attribute = :password, validations: true)
  # 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

  include InstanceMethodsOnActivation.new(attribute)

  if validations
    include ActiveModel::Validations

    # 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(attribute, :blank) unless record.send("#{attribute}_digest").present?
    end

    validates_length_of attribute, maximum: ActiveModel::SecurePassword::MAX_PASSWORD_LENGTH_ALLOWED
    validates_confirmation_of attribute, allow_blank: true
  end
end

Добавляет методы для установки и проверки паролей с помощью BCrypt. Этот механизм требует наличия атрибута XXX_digest. Где XXX — имя атрибута вашего пароля.

Следующие валидации добавляются автоматически:

  • Пароль должен быть присутствовать при создании

  • Длина пароля должна быть меньше или равна 72 байтам

  • Подтверждение пароля (используя атрибут XXX_confirmation)

Если подтверждение валидации не нужно, просто опустите значение для XXX_confirmation (т.е. не предоставляйте для него поле формы). Когда у этого атрибута есть значение nil, валидация не будет срабатывать.

Для большей настраиваемости можно подавить стандартные валидации, передав validations: false в качестве аргумента.

Добавьте bcrypt (~> 3.1.7) в Gemfile, чтобы использовать has_secure_password:

gem 'bcrypt', '~> 3.1.7'

Пример использования с Active Record (который автоматически включает ActiveModel::SecurePassword):

# Schema: User(name:string, password_digest:string, recovery_password_digest:string)
class User < ActiveRecord::Base
  has_secure_password
  has_secure_password :recovery_password, validations: false
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.recovery_password = "42password"
user.recovery_password_digest                                   # => "$2a$04$iOfhwahFymCs5weB3BNH/uXkTG65HR.qpW.bNhEjFP3ftli3o5DQC"
user.save                                                       # => true
user.authenticate('notright')                                   # => false
user.authenticate('mUc3m00RsqyRe')                              # => user
user.authenticate_recovery_password('42password')               # => user
User.find_by(name: 'david').try(:authenticate, 'notright')      # => false
User.find_by(name: 'david').try(:authenticate, 'mUc3m00RsqyRe') # => user

© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API