迁移 Amazon S3 加密客户端 - 适用于 Ruby 的 Amazon 开发工具包
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

迁移 Amazon S3 加密客户端

本主题介绍了如何将应用程序从 Amazon 简单存储服务 (Amazon S3) 加密客户端的版本 1 (V1) 迁移到版本 2 (V2),并确保应用程序在整个迁移过程中的可用性。

迁移概述

此迁移分两个阶段进行:

1. 更新现有客户端以阅读新格式。首先,部署更新版本的AmazonSDK for Ruby 应用程序。这将允许现有的 V1 加密客户端解密新 V2 客户端编写的对象。如果你的应用程序使用多AmazonSDK,你必须分别升级每个 SDK。

2. 将加密和解密客户端迁移到 V2。一旦所有 V1 加密客户端都能读取新格式,您就可以将现有的加密和解密客户端迁移到各自的 V2 版本。

更新现有客户端以阅读新格式

V2 加密客户端使用旧版本的客户端不支持的加密算法。迁移的第一步是将 V1 解密客户端更新到最新的 SDK 版本。完成此步骤后,应用程序的 V1 客户端将能够解密由 V2 加密客户端加密的对象。请参阅下面的详细信息了解每个主要版本AmazonSDK for Ruby。

更新AmazonSDK for Ruby

版本 3 是最新版本的Amazon适用于 Ruby 的 SDK。要完成此迁移,您需要使用 1.76.0 或更高版本aws-sdk-s3Gem。

从命令行安装

对于安装aws-sdk-s3gem 中,使用版本选项验证是否已安装最低版本 1.76.0。

gem install aws-sdk-s3 -v '>= 1.76.0'

使用 Gemfiles

对于使用 Gemfile 管理依赖项的项目,请设置aws-sdk-s3宝石至 1.76.0。例如:

gem 'aws-sdk-s3', '>= 1.76.0'
  1. 修改 Gemfile。

  2. 运行 bundle update aws-sdk-s3。要验证你的版本,请运行bundle info aws-sdk-s3.

更新AmazonSDK for Ruby

的版本 2AmazonSDK for Ruby维护模式2021 年 11 月 21 日。要完成此迁移,您需要使用 aws-sdk Gem 版本 2.11.562 或更高版本。

从命令行安装

对于安装aws-sdkgem,在命令行中,使用版本选项验证是否已安装 2.11.562 的最低版本。

gem install aws-sdk -v '>= 2.11.562'

使用 Gemfiles

对于使用 Gemfile 管理依赖项的项目,请设置aws-sdk宝石至 2.11.562。例如:

gem 'aws-sdk', '>= 2.11.562'
  1. 修改 Gemfile。如果你有 Gemfile.Lock 文件,请删除或更新它。

  2. 运行 bundle update aws-sdk。要验证你的版本,请运行bundle info aws-sdk.

将加密和解密客户端迁移到 V2

更新客户端以阅读新的加密格式后,您可以将应用程序更新为 V2 加密和解密客户端。以下步骤介绍如何将代码从 V1 成功迁移到 V2。

在更新代码以使用 V2 加密客户端之前,请确保您已按照上述步骤操作并使用aws-sdk-s3gem 版本 2.11.562 或更高版本。

注意

使用 AES-GCM 解密时,在开始使用解密的数据之前,先读取整个对象到底。这是为了验证对象自加密以来是否尚未修改。

配置 V2 加密客户端

这些区域有:加密v2። 客户端需要额外的配置。有关详细配置信息,请参阅Encryptionv2። 客户端文档或本主题后面提供的示例。

1. 必须在客户端构建时指定密钥包装方法和内容加密算法。创建新的时候EncryptionV2::Client您需要为提供的值key_wrap_schemacontent_encryption_schema.

key_wrap_schema-如果您在使用Amazon KMS此项必须设置为:kms_context. 如果您使用的是对称 (AES) 密钥,则必须将其设置为:aes_gcm. 如果您使用的是非对称 (RSA) 密钥,则必须将其设置为:rsa_oaep_sha1.

content_encryption_schema-此项必须设置为: aes_gcm_no_ 填充.

2.客户端构造时必须指定 security_profile。创建新的时候EncryptionV2::Client您需要为提供一个值security_profile. 这些区域有:安全 _ 配置文件参数确定了读取使用较旧版本的 V1 编写的对象的支持Encryption::Client. 有两个值::2:v2_and_遗产. 要支持迁移,请将security_profile:v2_and_遗产. 使用:2仅适用于新应用程序开发。

3.Amazon KMS 默认情况下,CMK ID 是强制执行的。在 V1Encryption::Clientkms_key_id没有提供用于创建客户端的Amazon KMS Decrypt call.Amazon KMS可以从元数据中获取此信息并将其添加到对称密文 blob 中。在 V2 中,e`ncryptionv2። 客户端 `,kms_key_id传递给Amazon KMS解密调用,如果调用与用于加密对象的密钥不匹配,则调用将失败。如果你之前的代码依赖于不设置特定kms_key_id,要么设置kms_key_id: :kms_allow_decrypt_with_any_cmk在客户端创建或设置kms_allow_decrypt_with_any_cmk: trueget_object调用。

例如:使用对称 (AES) 密钥

预迁移

client = Aws::S3::Encryption::Client.new(encryption_key: aes_key) client.put_object(bucket: bucket, key: key, body: secret_data) resp = client.get_object(bucket: bucket, key: key)

迁移后

client = Aws::S3::EncryptionV2::Client.new( encryption_key: rsa_key, key_wrap_schema: :rsa_oaep_sha1, # the key_wrap_schema must be rsa_oaep_sha1 for asymmetric keys content_encryption_schema: :aes_gcm_no_padding, security_profile: :v2_and_legacy # to allow reading/decrypting objects encrypted by the V1 encryption client ) client.put_object(bucket: bucket, key: key, body: secret_data) # No changes resp = client.get_object(bucket: bucket, key: key) # No changes

例如:使用Amazon KMS使用 kms_key_id

预迁移

client = Aws::S3::Encryption::Client.new(kms_key_id: kms_key_id) client.put_object(bucket: bucket, key: key, body: secret_data) resp = client.get_object(bucket: bucket, key: key)

迁移后

client = Aws::S3::EncryptionV2::Client.new( kms_key_id: kms_key_id, key_wrap_schema: :kms_context, # the key_wrap_schema must be kms_context for KMS keys content_encryption_schema: :aes_gcm_no_padding, security_profile: :v2_and_legacy # to allow reading/decrypting objects encrypted by the V1 encryption client ) client.put_object(bucket: bucket, key: key, body: secret_data) # No changes resp = client.get_object(bucket: bucket, key: key) # No change

例如:使用Amazon KMS没有 kms_key_id

预迁移

client = Aws::S3::Encryption::Client.new(kms_key_id: kms_key_id) client.put_object(bucket: bucket, key: key, body: secret_data) resp = client.get_object(bucket: bucket, key: key)

迁移后

client = Aws::S3::EncryptionV2::Client.new( kms_key_id: kms_key_id, key_wrap_schema: :kms_context, # the key_wrap_schema must be kms_context for KMS keys content_encryption_schema: :aes_gcm_no_padding, security_profile: :v2_and_legacy # to allow reading/decrypting objects encrypted by the V1 encryption client ) client.put_object(bucket: bucket, key: key, body: secret_data) # No changes resp = client.get_object(bucket: bucket, key: key, kms_allow_decrypt_with_any_cmk: true) # To allow decrypting with any cmk

迁移后替代方案

如果您只使用 S2 加密客户端读取和解密(切勿写入和加密)对象,请使用此代码。

client = Aws::S3::EncryptionV2::Client.new( kms_key_id: :kms_allow_decrypt_with_any_cmk, # set kms_key_id to allow all get_object requests to use any cmk key_wrap_schema: :kms_context, # the key_wrap_schema must be kms_context for KMS keys content_encryption_schema: :aes_gcm_no_padding, security_profile: :v2_and_legacy # to allow reading/decrypting objects encrypted by the V1 encryption client ) resp = client.get_object(bucket: bucket, key: key) # No change