aws-sdk-s3 1.53.0 → 1.146.0

data/lib/aws-sdk-s3/encryptionV2/io_encrypter.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'stringio'
+require 'tempfile'
+
+module Aws
+  module S3
+    module EncryptionV2
+
+      # Provides an IO wrapper encrypting a stream of data.
+      # @api private
+      class IOEncrypter
+
+        # @api private
+        ONE_MEGABYTE = 1024 * 1024
+
+        def initialize(cipher, io)
+          @encrypted = io.size <= ONE_MEGABYTE ?
+            encrypt_to_stringio(cipher, io.read) :
+            encrypt_to_tempfile(cipher, io)
+          @size = @encrypted.size
+        end
+
+        # @return [Integer]
+        attr_reader :size
+
+        def read(bytes = nil, output_buffer = nil)
+          if @encrypted.is_a?(Tempfile) && @encrypted.closed?
+            @encrypted.open
+            @encrypted.binmode
+          end
+          @encrypted.read(bytes, output_buffer)
+        end
+
+        def rewind
+          @encrypted.rewind
+        end
+
+        # @api private
+        def close
+          @encrypted.close if @encrypted.is_a?(Tempfile)
+        end
+
+        private
+
+        def encrypt_to_stringio(cipher, plain_text)
+          if plain_text.empty?
+            StringIO.new(cipher.final + cipher.auth_tag)
+          else
+            StringIO.new(cipher.update(plain_text) + cipher.final + cipher.auth_tag)
+          end
+        end
+
+        def encrypt_to_tempfile(cipher, io)
+          encrypted = Tempfile.new(self.object_id.to_s)
+          encrypted.binmode
+          while chunk = io.read(ONE_MEGABYTE, read_buffer ||= String.new)
+            if cipher.method(:update).arity == 1
+              encrypted.write(cipher.update(chunk))
+            else
+              encrypted.write(cipher.update(chunk, cipher_buffer ||= String.new))
+            end
+          end
+          encrypted.write(cipher.final)
+          encrypted.write(cipher.auth_tag)
+          encrypted.rewind
+          encrypted
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/encryptionV2/key_provider.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module EncryptionV2
+
+      # This module defines the interface required for a {Client#key_provider}.
+      # A key provider is any object that:
+      #
+      # * Responds to {#encryption_materials} with an {Materials} object.
+      #
+      # * Responds to {#key_for}, receiving a JSON document String,
+      #   returning an encryption key. The returned encryption key
+      #   must be one of:
+      #
+      #   * `OpenSSL::PKey::RSA` - for asymmetric encryption
+      #   * `String` - 32, 24, or 16 bytes long, for symmetric encryption
+      #
+      module KeyProvider
+
+        # @return [Materials]
+        def encryption_materials; end
+
+        # @param [String<JSON>] materials_description
+        # @return [OpenSSL::PKey::RSA, String] encryption_key
+        def key_for(materials_description); end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Aws
+  module S3
+    module EncryptionV2
+      # @api private
+      class KmsCipherProvider
+
+        def initialize(options = {})
+          @kms_key_id = validate_kms_key(options[:kms_key_id])
+          @kms_client = options[:kms_client]
+          @key_wrap_schema = validate_key_wrap(
+            options[:key_wrap_schema]
+          )
+          @content_encryption_schema = validate_cek(
+            options[:content_encryption_schema]
+          )
+        end
+
+        # @return [Array<Hash,Cipher>] Creates and returns a new encryption
+        #   envelope and encryption cipher.
+        def encryption_cipher(options = {})
+          validate_key_for_encryption
+          encryption_context = build_encryption_context(@content_encryption_schema, options)
+          key_data = Aws::Plugins::UserAgent.feature('S3CryptoV2') do
+            @kms_client.generate_data_key(
+              key_id: @kms_key_id,
+              encryption_context: encryption_context,
+              key_spec: 'AES_256'
+            )
+          end
+          cipher = Utils.aes_encryption_cipher(:GCM)
+          cipher.key = key_data.plaintext
+          envelope = {
+            'x-amz-key-v2' => encode64(key_data.ciphertext_blob),
+            'x-amz-iv' => encode64(cipher.iv = cipher.random_iv),
+            'x-amz-cek-alg' => @content_encryption_schema,
+            'x-amz-tag-len' => (AES_GCM_TAG_LEN_BYTES * 8).to_s,
+            'x-amz-wrap-alg' => @key_wrap_schema,
+            'x-amz-matdesc' => Json.dump(encryption_context)
+          }
+          cipher.auth_data = '' # auth_data must be set after key and iv
+          [envelope, cipher]
+        end
+
+        # @return [Cipher] Given an encryption envelope, returns a
+        #   decryption cipher.
+        def decryption_cipher(envelope, options = {})
+          encryption_context = Json.load(envelope['x-amz-matdesc'])
+          cek_alg = envelope['x-amz-cek-alg']
+
+          case envelope['x-amz-wrap-alg']
+          when 'kms'
+            unless options[:security_profile] == :v2_and_legacy
+              raise Errors::LegacyDecryptionError
+            end
+          when 'kms+context'
+            if cek_alg != encryption_context['aws:x-amz-cek-alg']
+              raise Errors::CEKAlgMismatchError
+            end
+
+            if encryption_context != build_encryption_context(cek_alg, options)
+              raise Errors::DecryptionError, 'Value of encryption context from'\
+                ' envelope does not match the provided encryption context'
+            end
+          when 'AES/GCM'
+            raise ArgumentError, 'Key mismatch - Client is configured' \
+                    ' with a KMS key and the x-amz-wrap-alg is AES/GCM.'
+          when 'RSA-OAEP-SHA1'
+            raise ArgumentError, 'Key mismatch - Client is configured' \
+                    ' with a KMS key and the x-amz-wrap-alg is RSA-OAEP-SHA1.'
+          else
+            raise ArgumentError, 'Unsupported wrap-alg: ' \
+                "#{envelope['x-amz-wrap-alg']}"
+          end
+
+          any_cmk_mode = false || options[:kms_allow_decrypt_with_any_cmk]
+          decrypt_options = {
+            ciphertext_blob: decode64(envelope['x-amz-key-v2']),
+            encryption_context: encryption_context
+          }
+          unless any_cmk_mode
+            decrypt_options[:key_id] = @kms_key_id
+          end
+
+          key = Aws::Plugins::UserAgent.feature('S3CryptoV2') do
+            @kms_client.decrypt(decrypt_options).plaintext
+          end
+          iv = decode64(envelope['x-amz-iv'])
+          block_mode =
+            case cek_alg
+            when 'AES/CBC/PKCS5Padding'
+              :CBC
+            when 'AES/CBC/PKCS7Padding'
+              :CBC
+            when 'AES/GCM/NoPadding'
+              :GCM
+            else
+              type = envelope['x-amz-cek-alg'].inspect
+              msg = "unsupported content encrypting key (cek) format: #{type}"
+              raise Errors::DecryptionError, msg
+            end
+          Utils.aes_decryption_cipher(block_mode, key, iv)
+        end
+
+        private
+
+        def validate_key_wrap(key_wrap_schema)
+          case key_wrap_schema
+          when :kms_context then 'kms+context'
+          else
+            raise ArgumentError, "Unsupported key_wrap_schema: #{key_wrap_schema}"
+          end
+        end
+
+        def validate_cek(content_encryption_schema)
+          case content_encryption_schema
+          when :aes_gcm_no_padding
+            "AES/GCM/NoPadding"
+          else
+            raise ArgumentError, "Unsupported content_encryption_schema: #{content_encryption_schema}"
+          end
+        end
+
+        def validate_kms_key(kms_key_id)
+          if kms_key_id.nil? || kms_key_id.length.zero?
+            raise ArgumentError, 'KMS CMK ID was not specified. ' \
+              'Please specify a CMK ID, ' \
+              'or set kms_key_id: :kms_allow_decrypt_with_any_cmk to use ' \
+              'any valid CMK from the object.'
+          end
+
+          if kms_key_id.is_a?(Symbol) && kms_key_id != :kms_allow_decrypt_with_any_cmk
+            raise ArgumentError, 'kms_key_id must be a valid KMS CMK or be ' \
+              'set to :kms_allow_decrypt_with_any_cmk'
+          end
+          kms_key_id
+        end
+
+        def build_encryption_context(cek_alg, options = {})
+          kms_context = (options[:kms_encryption_context] || {})
+            .each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+          if kms_context.include? 'aws:x-amz-cek-alg'
+            raise ArgumentError, 'Conflict in reserved KMS Encryption Context ' \
+              'key aws:x-amz-cek-alg. This value is reserved for the S3 ' \
+              'Encryption Client and cannot be set by the user.'
+          end
+          {
+            'aws:x-amz-cek-alg' => cek_alg
+          }.merge(kms_context)
+        end
+
+        def encode64(str)
+          Base64.encode64(str).split("\n") * ""
+        end
+
+        def decode64(str)
+          Base64.decode64(str)
+        end
+
+        def validate_key_for_encryption
+          if @kms_key_id == :kms_allow_decrypt_with_any_cmk
+            raise ArgumentError, 'Unable to encrypt/write objects with '\
+              'kms_key_id = :kms_allow_decrypt_with_any_cmk.  Provide ' \
+              'a valid kms_key_id on client construction.'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/encryptionV2/materials.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Aws
+  module S3
+    module EncryptionV2
+      class Materials
+
+        # @option options [required, OpenSSL::PKey::RSA, String] :key
+        #   The master key to use for encrypting/decrypting all objects.
+        #
+        # @option options [String<JSON>] :description ('{}')
+        #   The encryption materials description. This is must be
+        #   a JSON document string.
+        #
+        def initialize(options = {})
+          @key = validate_key(options[:key])
+          @description = validate_desc(options[:description])
+        end
+
+        # @return [OpenSSL::PKey::RSA, String]
+        attr_reader :key
+
+        # @return [String<JSON>]
+        attr_reader :description
+
+        private
+
+        def validate_key(key)
+          case key
+          when OpenSSL::PKey::RSA then key
+          when String
+            if [32, 24, 16].include?(key.bytesize)
+              key
+            else
+              msg = 'invalid key, symmetric key required to be 16, 24, or '\
+                    '32 bytes in length, saw length ' + key.bytesize.to_s
+              raise ArgumentError, msg
+            end
+          else
+            msg = 'invalid encryption key, expected an OpenSSL::PKey::RSA key '\
+                  '(for asymmetric encryption) or a String (for symmetric '\
+                  'encryption).'
+            raise ArgumentError, msg
+          end
+        end
+
+        def validate_desc(description)
+          Json.load(description)
+          description
+        rescue Json::ParseError, EncodingError
+          msg = 'expected description to be a valid JSON document string'
+          raise ArgumentError, msg
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/encryptionV2/utils.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module Aws
+  module S3
+    module EncryptionV2
+      # @api private
+      module Utils
+
+        class << self
+
+          def encrypt_aes_gcm(key, data, auth_data)
+            cipher = aes_encryption_cipher(:GCM, key)
+            cipher.iv = (iv = cipher.random_iv)
+            cipher.auth_data = auth_data
+
+            iv + cipher.update(data) + cipher.final + cipher.auth_tag
+          end
+
+          def encrypt_rsa(key, data, auth_data)
+            # Plaintext must be KeyLengthInBytes (1 Byte) + DataKey + AuthData
+            buf = [data.bytesize] + data.unpack('C*') + auth_data.unpack('C*')
+            key.public_encrypt(buf.pack('C*'), OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING)
+          end
+
+          def decrypt(key, data)
+            begin
+              case key
+              when OpenSSL::PKey::RSA # asymmetric decryption
+                key.private_decrypt(data)
+              when String # symmetric Decryption
+                cipher = aes_cipher(:decrypt, :ECB, key, nil)
+                cipher.update(data) + cipher.final
+              end
+            rescue OpenSSL::Cipher::CipherError
+              msg = 'decryption failed, possible incorrect key'
+              raise Errors::DecryptionError, msg
+            end
+          end
+
+          def decrypt_aes_gcm(key, data, auth_data)
+            # data is iv (12B) + key + tag (16B)
+            buf = data.unpack('C*')
+            iv = buf[0,12].pack('C*') # iv will always be 12 bytes
+            tag = buf[-16, 16].pack('C*') # tag is 16 bytes
+            enc_key = buf[12, buf.size - (12+16)].pack('C*')
+            cipher = aes_cipher(:decrypt, :GCM, key, iv)
+            cipher.auth_tag = tag
+            cipher.auth_data = auth_data
+            cipher.update(enc_key) + cipher.final
+          end
+
+          # returns the decrypted data + auth_data
+          def decrypt_rsa(key, enc_data)
+            # Plaintext must be KeyLengthInBytes (1 Byte) + DataKey + AuthData
+            buf = key.private_decrypt(enc_data, OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING).unpack('C*')
+            key_length = buf[0]
+            data = buf[1, key_length].pack('C*')
+            auth_data = buf[key_length+1, buf.length - key_length].pack('C*')
+            [data, auth_data]
+          end
+
+          # @param [String] block_mode "CBC" or "ECB"
+          # @param [OpenSSL::PKey::RSA, String, nil] key
+          # @param [String, nil] iv The initialization vector
+          def aes_encryption_cipher(block_mode, key = nil, iv = nil)
+            aes_cipher(:encrypt, block_mode, key, iv)
+          end
+
+          # @param [String] block_mode "CBC" or "ECB"
+          # @param [OpenSSL::PKey::RSA, String, nil] key
+          # @param [String, nil] iv The initialization vector
+          def aes_decryption_cipher(block_mode, key = nil, iv = nil)
+            aes_cipher(:decrypt, block_mode, key, iv)
+          end
+
+          # @param [String] mode "encrypt" or "decrypt"
+          # @param [String] block_mode "CBC" or "ECB"
+          # @param [OpenSSL::PKey::RSA, String, nil] key
+          # @param [String, nil] iv The initialization vector
+          def aes_cipher(mode, block_mode, key, iv)
+            cipher = key ?
+              OpenSSL::Cipher.new("aes-#{cipher_size(key)}-#{block_mode.downcase}") :
+              OpenSSL::Cipher.new("aes-256-#{block_mode.downcase}")
+            cipher.send(mode) # encrypt or decrypt
+            cipher.key = key if key
+            cipher.iv = iv if iv
+            cipher
+          end
+
+          # @param [String] key
+          # @return [Integer]
+          # @raise ArgumentError
+          def cipher_size(key)
+            key.bytesize * 8
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/encryption_v2.rb

@@ -0,0 +1,23 @@
+require 'aws-sdk-s3/encryptionV2/client'
+require 'aws-sdk-s3/encryptionV2/decrypt_handler'
+require 'aws-sdk-s3/encryptionV2/default_cipher_provider'
+require 'aws-sdk-s3/encryptionV2/encrypt_handler'
+require 'aws-sdk-s3/encryptionV2/errors'
+require 'aws-sdk-s3/encryptionV2/io_encrypter'
+require 'aws-sdk-s3/encryptionV2/io_decrypter'
+require 'aws-sdk-s3/encryptionV2/io_auth_decrypter'
+require 'aws-sdk-s3/encryptionV2/key_provider'
+require 'aws-sdk-s3/encryptionV2/kms_cipher_provider'
+require 'aws-sdk-s3/encryptionV2/materials'
+require 'aws-sdk-s3/encryptionV2/utils'
+require 'aws-sdk-s3/encryptionV2/default_key_provider'
+
+module Aws
+  module S3
+    module EncryptionV2
+      AES_GCM_TAG_LEN_BYTES = 16
+      EC_USER_AGENT = 'S3CryptoV2'
+    end
+  end
+end
+

data/lib/aws-sdk-s3/endpoint_parameters.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::S3
+  # Endpoint parameters used to influence endpoints per request.
+  #
+  # @!attribute bucket
+  #   The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.
+  #
+  #   @return [String]
+  #
+  # @!attribute region
+  #   The AWS region used to dispatch the request.
+  #
+  #   @return [String]
+  #
+  # @!attribute use_fips
+  #   When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute use_dual_stack
+  #   When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute endpoint
+  #   Override the endpoint used to send this request
+  #
+  #   @return [String]
+  #
+  # @!attribute force_path_style
+  #   When true, force a path-style endpoint to be used where the bucket name is part of the path.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute accelerate
+  #   When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute use_global_endpoint
+  #   Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute use_object_lambda_endpoint
+  #   Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute key
+  #   The S3 Key used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Key.
+  #
+  #   @return [String]
+  #
+  # @!attribute prefix
+  #   The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix.
+  #
+  #   @return [String]
+  #
+  # @!attribute disable_access_points
+  #   Internal parameter to disable Access Point Buckets
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute disable_multi_region_access_points
+  #   Whether multi-region access points (MRAP) should be disabled.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute use_arn_region
+  #   When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute use_s3_express_control_endpoint
+  #   Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute disable_s3_express_session_auth
+  #   Parameter to indicate whether S3Express session auth should be disabled
+  #
+  #   @return [Boolean]
+  #
+  EndpointParameters = Struct.new(
+    :bucket,
+    :region,
+    :use_fips,
+    :use_dual_stack,
+    :endpoint,
+    :force_path_style,
+    :accelerate,
+    :use_global_endpoint,
+    :use_object_lambda_endpoint,
+    :key,
+    :prefix,
+    :disable_access_points,
+    :disable_multi_region_access_points,
+    :use_arn_region,
+    :use_s3_express_control_endpoint,
+    :disable_s3_express_session_auth,
+  ) do
+    include Aws::Structure
+
+    # @api private
+    class << self
+      PARAM_MAP = {
+        'Bucket' => :bucket,
+        'Region' => :region,
+        'UseFIPS' => :use_fips,
+        'UseDualStack' => :use_dual_stack,
+        'Endpoint' => :endpoint,
+        'ForcePathStyle' => :force_path_style,
+        'Accelerate' => :accelerate,
+        'UseGlobalEndpoint' => :use_global_endpoint,
+        'UseObjectLambdaEndpoint' => :use_object_lambda_endpoint,
+        'Key' => :key,
+        'Prefix' => :prefix,
+        'DisableAccessPoints' => :disable_access_points,
+        'DisableMultiRegionAccessPoints' => :disable_multi_region_access_points,
+        'UseArnRegion' => :use_arn_region,
+        'UseS3ExpressControlEndpoint' => :use_s3_express_control_endpoint,
+        'DisableS3ExpressSessionAuth' => :disable_s3_express_session_auth,
+      }.freeze
+    end
+
+    def initialize(options = {})
+      self[:bucket] = options[:bucket]
+      self[:region] = options[:region]
+      self[:use_fips] = options[:use_fips]
+      self[:use_fips] = false if self[:use_fips].nil?
+      if self[:use_fips].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :use_fips"
+      end
+      self[:use_dual_stack] = options[:use_dual_stack]
+      self[:use_dual_stack] = false if self[:use_dual_stack].nil?
+      if self[:use_dual_stack].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack"
+      end
+      self[:endpoint] = options[:endpoint]
+      self[:force_path_style] = options[:force_path_style]
+      self[:force_path_style] = false if self[:force_path_style].nil?
+      if self[:force_path_style].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :force_path_style"
+      end
+      self[:accelerate] = options[:accelerate]
+      self[:accelerate] = false if self[:accelerate].nil?
+      if self[:accelerate].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :accelerate"
+      end
+      self[:use_global_endpoint] = options[:use_global_endpoint]
+      self[:use_global_endpoint] = false if self[:use_global_endpoint].nil?
+      if self[:use_global_endpoint].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :use_global_endpoint"
+      end
+      self[:use_object_lambda_endpoint] = options[:use_object_lambda_endpoint]
+      self[:key] = options[:key]
+      self[:prefix] = options[:prefix]
+      self[:disable_access_points] = options[:disable_access_points]
+      self[:disable_multi_region_access_points] = options[:disable_multi_region_access_points]
+      self[:disable_multi_region_access_points] = false if self[:disable_multi_region_access_points].nil?
+      if self[:disable_multi_region_access_points].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :disable_multi_region_access_points"
+      end
+      self[:use_arn_region] = options[:use_arn_region]
+      self[:use_s3_express_control_endpoint] = options[:use_s3_express_control_endpoint]
+      self[:disable_s3_express_session_auth] = options[:disable_s3_express_session_auth]
+    end
+  end
+end