Spec-Zone.ru › Ruby on Rails 7.2

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

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

Общедоступные методы экземпляров

has_secure_password(attribute = :password, validations: true) Показать исходный код
# File activemodel/lib/active_model/secure_password.rb, line 101
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
    warn "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.public_send("#{attribute}_digest").present?
    end

    validate do |record|
      if challenge = record.public_send(:"#{attribute}_challenge")
        digest_was = record.public_send(:"#{attribute}_digest_was") if record.respond_to?(:"#{attribute}_digest_was")

        unless digest_was.present? && BCrypt::Password.new(digest_was).is_password?(challenge)
          record.errors.add(:"#{attribute}_challenge")
        end
      end
    end

    # Validates that the password does not exceed the maximum allowed bytes for BCrypt (72 bytes).
    validate do |record|
      password_value = record.public_send(attribute)
      if password_value.present? && password_value.bytesize > ActiveModel::SecurePassword::MAX_PASSWORD_LENGTH_ALLOWED
        record.errors.add(attribute, :password_too_long)
      end
    end

    validates_confirmation_of attribute, allow_blank: true
  end
end

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

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

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

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

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

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

Кроме того, создается атрибут XXX_challenge. Когда ему присваивается значение, отличное от nil, будет выполнена валидация по отношению к текущему сохранённому паролю. Эта валидация опирается на отслеживание изменений, как предоставлено ActiveModel::Dirty; если методы отслеживания изменений не определены, эта валидация завершится ошибкой.

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

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

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 = "vr00m"
user.save                                                      # => false, confirmation doesn't match
user.password_confirmation = "vr00m"
user.save                                                      # => true

user.authenticate("notright")                                  # => false
user.authenticate("vr00m")                                     # => user
User.find_by(name: "david")&.authenticate("notright")          # => false
User.find_by(name: "david")&.authenticate("vr00m")             # => user

user.recovery_password = "42password"
user.recovery_password_digest                                  # => "$2a$04$iOfhwahFymCs5weB3BNH/uXkTG65HR.qpW.bNhEjFP3ftli3o5DQC"
user.save                                                      # => true

user.authenticate_recovery_password("42password")              # => user

user.update(password: "pwn3d", password_challenge: "")         # => false, challenge doesn't authenticate
user.update(password: "nohack4u", password_challenge: "vr00m") # => true

user.authenticate("vr00m")                                     # => false, old password
user.authenticate("nohack4u")                                  # => user
Условное требование пароля
class Account
  include ActiveModel::SecurePassword

  attr_accessor :is_guest, :password_digest

  has_secure_password

  def errors
    super.tap { |errors| errors.delete(:password, :blank) if is_guest }
  end
end

account = Account.new
account.valid? # => false, password required

account.is_guest = true
account.valid? # => true

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

Spec-Zone.ru

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