- #
- C
- I
- O
- R
属性
[读写] | transitional | 如果为真,则在构建消息加密器时交换前两个旋转选项集。例如,使用以下配置,消息加密器将使用
这在执行应用程序的滚动部署时非常有用,其中尚未更新的服务器仍然必须能够解密来自更新服务器的消息。在这种情况下,首先使用新的旋转(例如 |
实例公共方法
[](salt) 链接
返回一个 MessageEncryptor
,其配置使用从给定salt
派生的密钥,以及来自 rotate
的选项。 MessageEncryptor
实例将被记忆化,因此相同的salt
将返回相同的实例。
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 48
[]=(salt, encryptor) 链接
覆盖与给定salt
关联的 MessageEncryptor
实例。
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 56
clear_rotations 链接
清除选项集列表。
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 117
initialize(&secret_generator) 链接
初始化一个新实例。secret_generator
必须接受一个 salt 和一个 secret_length
kwarg,并返回一个合适的密钥(字符串)或密钥(字符串数组)。secret_generator
也可以接受其他任意 kwargs。如果 rotate
被调用带有与那些 kwargs 匹配的任何选项,这些选项将被传递给 secret_generator
而不是传递给消息加密器。
encryptors = ActiveSupport::MessageEncryptors.new do |salt, secret_length:, base:|
MySecretGenerator.new(base).generate(salt, secret_length)
end
encryptors.rotate(base: "...")
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 31
on_rotation(&callback) 链接
设置一个回调,当使用除第一个以外的选项集解密消息时调用。
例如,此回调可以记录每次调用时的情况,从而指示旧选项集是否仍在使用或是否可以从旋转中删除。
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 123
rotate(**options)
rotate(&block) 链接
将options
添加到选项集列表中。 Messages
将使用列表中的第一个集合加密。但是,在解密时,将按顺序尝试每个集合,直到成功。
值得注意的是,:secret_generator
选项可以指定与最初指定的密钥生成器不同的密钥生成器。密钥生成器必须响应 call
,接受 salt 和 secret_length
kwarg,并返回一个合适的密钥(字符串)或密钥(字符串数组)。密钥生成器也可以接受其他任意 kwargs。
如果任何选项与有效密钥生成器的 kwargs 相匹配,这些选项将被传递给密钥生成器,而不是传递给消息加密器。
为了实现细粒度的逐盐旋转,支持块形式。块将接收 salt,并应返回一个适当的选项 Hash
。块也可以返回 nil
来指示旋转不适用于给定的 salt。例如
encryptors = ActiveSupport::MessageEncryptors.new { ... }
encryptors.rotate do |salt|
case salt
when :foo
{ serializer: JSON, url_safe: true }
when :bar
{ serializer: Marshal, url_safe: true }
end
end
encryptors.rotate(serializer: Marshal, url_safe: false)
# Uses `serializer: JSON, url_safe: true`.
# Falls back to `serializer: Marshal, url_safe: false`.
encryptors[:foo]
# Uses `serializer: Marshal, url_safe: true`.
# Falls back to `serializer: Marshal, url_safe: false`.
encryptors[:bar]
# Uses `serializer: Marshal, url_safe: false`.
encryptors[:baz]
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 62
rotate_defaults 链接
使用默认选项调用 rotate
。
来源: 在 GitHub 上
# File activesupport/lib/active_support/message_encryptors.rb, line 111