модуль ActiveRecord::SecureToken::ClassMethods
Публичные методы экземпляров
# File activerecord/lib/active_record/secure_token.rb, line 61 def generate_unique_secure_token(length: MINIMUM_TOKEN_LENGTH) SecureRandom.base58(length) end
# File activerecord/lib/active_record/secure_token.rb, line 46
def has_secure_token(attribute = :token, length: MINIMUM_TOKEN_LENGTH, on: ActiveRecord.generate_secure_token_on)
if length < MINIMUM_TOKEN_LENGTH
raise MinimumLengthError, "Token requires a minimum length of #{MINIMUM_TOKEN_LENGTH} characters."
end
# Load securerandom only when has_secure_token is used.
require "active_support/core_ext/securerandom"
define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_secure_token(length: length) }
set_callback on, on == :initialize ? :after : :before do
if new_record? && !query_attribute(attribute)
send("#{attribute}=", self.class.generate_unique_secure_token(length: length))
end
end
end Пример использования has_secure_token
# Schema: User(token:string, auth_token:string) class User < ActiveRecord::Base has_secure_token has_secure_token :auth_token, length: 36 end user = User.new user.save user.token # => "pX27zsMN2ViQKta1bGfLmVJE" user.auth_token # => "tU9bLuZseefXQ4yQxQo8wjtBvsAfPc78os6R" user.regenerate_token # => true user.regenerate_auth_token # => true
SecureRandom::base58 используется для генерации уникального токена длиной не менее 24 символов, поэтому вероятность коллизий крайне низка.
Обратите внимание, что всё равно возможна гонка в базе данных, аналогично тому, как это может произойти с validates_uniqueness_of. Рекомендуется добавить уникальный индекс в базу данных, чтобы справиться с этим ещё более маловероятным сценарием.
Параметры
- :length
-
Длина Secure Random, с минимальной длиной 24 символа. По умолчанию — 24.
- :on
-
Обработчик при генерации значения. При вызове с
on: :initialize, значение генерируется вafter_initializeобработчике, в противном случае значение будет использовано вbefore_обработчике. Если не указано,:onбудет использовать значениеconfig.active_record.generate_secure_token_on, которое по умолчанию равно:initializeначиная с Rails 7.1.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.