класс ActiveSupport::MessageVerifier
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')
Ограничение сообщений определённым назначением
По умолчанию любое сообщение может быть использовано в приложении. Но их также можно ограничить определённым :purpose.
token = @verifier.generate("this is the chair", purpose: :login)
Затем при проверке необходимо передать то же назначение, чтобы получить данные обратно:
@verifier.verified(token, purpose: :login) # => "this is the chair" @verifier.verified(token, purpose: :shipping) # => nil @verifier.verified(token) # => nil @verifier.verify(token, purpose: :login) # => "this is the chair" @verifier.verify(token, purpose: :shipping) # => ActiveSupport::MessageVerifier::InvalidSignature @verifier.verify(token) # => ActiveSupport::MessageVerifier::InvalidSignature
Аналогично, если у сообщения нет назначения, оно не будет возвращено при проверке со специфическим назначением.
token = @verifier.generate("the conversation is lively")
@verifier.verified(token, purpose: :scare_tactics) # => nil
@verifier.verified(token) # => "the conversation is lively"
@verifier.verify(token, purpose: :scare_tactics) # => ActiveSupport::MessageVerifier::InvalidSignature
@verifier.verify(token) # => "the conversation is lively"
Установка срока действия сообщений
По умолчанию сообщения действуют вечно, и проверка через год всё ещё вернёт исходное значение. Но сообщения можно установить на истечение в заданное время с помощью :expires_in или :expires_at.
@verifier.generate(parcel, expires_in: 1.month) @verifier.generate(doowad, expires_at: Time.now.end_of_year)
Затем сообщения можно проверить и вернуть до истечения срока действия. После этого метод verified возвращает nil, в то время как verify вызывает исключение ActiveSupport::MessageVerifier::InvalidSignature.
Включение новых ключей
MessageVerifier также поддерживает обновление старых конфигураций, переключаясь на стек верификаторов. Вызовите rotate для создания и добавления верификатора, чтобы verified или verify также попытались выполнить проверку с помощью резервного варианта.
По умолчанию все обновлённые верификаторы используют значения основного верификатора, если не указано иное.
Вы задаёте новые значения по умолчанию своему верификатору:
verifier = ActiveSupport::MessageVerifier.new(@secret, digest: "SHA512", serializer: JSON)
Затем постепенно обновляйте старые значения, добавляя их как резервные варианты. Любое сообщение, сгенерированное со старыми значениями, будет работать до тех пор, пока обновление не будет удалено.
verifier.rotate old_secret # Fallback to an old secret instead of @secret. verifier.rotate digest: "SHA256" # Fallback to an old digest instead of SHA512. verifier.rotate serializer: Marshal # Fallback to an old serializer instead of JSON.
Хотя вышеописанное, скорее всего, будет объединёно в одно обновление:
verifier.rotate old_secret, digest: "SHA256", serializer: Marshal
Публичные методы класса
# File activesupport/lib/active_support/message_verifier.rb, line 106 def initialize(secret, digest: nil, serializer: nil) raise ArgumentError, "Secret should not be nil." unless secret @secret = secret @digest = digest || "SHA1" @serializer = serializer || Marshal end
Публичные методы экземпляра
# File activesupport/lib/active_support/message_verifier.rb, line 186
def generate(value, expires_at: nil, expires_in: nil, purpose: nil)
data = encode(Messages::Metadata.wrap(@serializer.dump(value), expires_at: expires_at, expires_in: expires_in, purpose: purpose))
"#{data}--#{generate_digest(data)}"
end Генерирует подписанное сообщение для предоставленного значения.
Сообщение подписывается секретом MessageVerifier. Возвращает Base64-кодированное сообщение, соединённое с сгенерированной подписью.
verifier = ActiveSupport::MessageVerifier.new 's3Krit' verifier.generate 'a private message' # => "BAhJIhRwcml2YXRlLW1lc3NhZ2UGOgZFVA==--e2d724331ebdee96a10fb99b089508d1c72bd772"
# File activesupport/lib/active_support/message_verifier.rb, line 122
def valid_message?(signed_message)
return if signed_message.nil? || !signed_message.valid_encoding? || signed_message.blank?
data, digest = signed_message.split("--")
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
# File activesupport/lib/active_support/message_verifier.rb, line 150
def verified(signed_message, purpose: nil, **)
if valid_message?(signed_message)
begin
data = signed_message.split("--")[0]
message = Messages::Metadata.verify(decode(data), purpose)
@serializer.load(message) if message
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
# File activesupport/lib/active_support/message_verifier.rb, line 175 def verify(*args, **options) verified(*args, **options) || 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
© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.