class ActiveSupport::MessageVerifier

Parent:: Объект

MessageVerifier упрощает создание и проверку подписанных сообщений для предотвращения подделки.

Это полезно в таких случаях, как токены «запомнить меня» и ссылки на автоматическую отписку, когда хранилище сессий не подходит или недоступно.

Запомнить меня:

cookies[:remember_me] = @verifier.generate([@user.id, 2.weeks.from_now])

В фильтре аутентификации:

id, time = @verifier.verify(cookies[:remember_me])
if Time.now < time
  self.current_user = User.find(id)
end

По умолчанию используется Marshal для сериализации сообщения. Если вы хотите использовать другой метод сериализации, вы можете установить сериализатор в хеше параметров при инициализации:

@verifier = ActiveSupport::MessageVerifier.new('s3Krit', serializer: YAML)

MessageVerifier создаёт HMAC-подписи с использованием алгоритма хеширования SHA1 по умолчанию. Если вы хотите использовать другой алгоритм хеширования, вы можете изменить его, указав ключ `:digest` в качестве параметра при инициализации верификатора:

@verifier = ActiveSupport::MessageVerifier.new('s3Krit', digest: 'SHA256')

Публичные методы класса

new(secret, options = {}) Показать исходный код

# File activesupport/lib/active_support/message_verifier.rb, line 36
def initialize(secret, options = {})
  raise ArgumentError, "Secret should not be nil." unless secret
  @secret = secret
  @digest = options[:digest] || "SHA1"
  @serializer = options[:serializer] || Marshal
end

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

generate(value) Показать исходный код

# File activesupport/lib/active_support/message_verifier.rb, line 115
def generate(value)
  data = encode(@serializer.dump(value))
  "#{data}--#{generate_digest(data)}"
end

Создаёт подписанное сообщение для предоставленного значения.

Сообщение подписывается с использованием секрета MessageVerifier. Без знания секрета из сообщения невозможно извлечь исходное значение.

verifier = ActiveSupport::MessageVerifier.new 's3Krit'
verifier.generate 'a private message' # => "BAhJIhRwcml2YXRlLW1lc3NhZ2UGOgZFVA==--e2d724331ebdee96a10fb99b089508d1c72bd772"

valid_message?(signed_message) Показать исходный код

# File activesupport/lib/active_support/message_verifier.rb, line 52
def valid_message?(signed_message)
  return if signed_message.nil? || !signed_message.valid_encoding? || signed_message.blank?

  data, digest = signed_message.split("--".freeze)
  data.present? && digest.present? && ActiveSupport::SecurityUtils.secure_compare(digest, generate_digest(data))
end

Проверяет, могло ли подписанное сообщение быть сгенерировано путём подписи объекта с использованием секрета MessageVerifier.

verifier = ActiveSupport::MessageVerifier.new 's3Krit'
signed_message = verifier.generate 'a private message'
verifier.valid_message?(signed_message) # => true

tampered_message = signed_message.chop # editing the message invalidates the signature
verifier.valid_message?(tampered_message) # => false

verified(signed_message) Показать исходный код

# File activesupport/lib/active_support/message_verifier.rb, line 80
def verified(signed_message)
  if valid_message?(signed_message)
    begin
      data = signed_message.split("--".freeze)[0]
      @serializer.load(decode(data))
    rescue ArgumentError => argument_error
      return if argument_error.message.include?("invalid base64")
      raise
    end
  end
end

Декодирует подписанное сообщение, используя секрет MessageVerifier.

verifier = ActiveSupport::MessageVerifier.new 's3Krit'

signed_message = verifier.generate 'a private message'
verifier.verified(signed_message) # => 'a private message'

Возвращает nil, если сообщение не было подписано с использованием того же секрета.

other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit'
other_verifier.verified(signed_message) # => nil

Возвращает nil, если сообщение не закодировано в Base64.

invalid_message = "f--46a0120593880c733a53b6dad75b42ddc1c8996d"
verifier.verified(invalid_message) # => nil

Выбрасывает любое исключение, возникшее во время декодирования подписанного сообщения.

incompatible_message = "test--dad7b06c94abba8d46a15fafaef56c327665d5ff"
verifier.verified(incompatible_message) # => TypeError: incompatible marshal file format

verify(signed_message) Показать исходный код

# File activesupport/lib/active_support/message_verifier.rb, line 104
def verify(signed_message)
  verified(signed_message) || raise(InvalidSignature)
end

Декодирует подписанное сообщение, используя секрет MessageVerifier.

verifier = ActiveSupport::MessageVerifier.new 's3Krit'
signed_message = verifier.generate 'a private message'

verifier.verify(signed_message) # => 'a private message'

Выбрасывает InvalidSignature, если сообщение не было подписано с использованием того же секрета или не было закодировано в Base64.

other_verifier = ActiveSupport::MessageVerifier.new 'd1ff3r3nt-s3Krit'
other_verifier.verify(signed_message) # => ActiveSupport::MessageVerifier::InvalidSignature