aws-sdk-s3 1.75.0

data/lib/aws-sdk-s3/plugins/expect_100_continue.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+      class Expect100Continue < Seahorse::Client::Plugin
+
+        def add_handlers(handlers, config)
+          if config.http_continue_timeout && config.http_continue_timeout > 0
+            handlers.add(Handler)
+          end
+        end
+
+        # @api private
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            if context.http_request.body && context.http_request.body.size > 0
+              context.http_request.headers['expect'] = '100-continue'
+            end
+            @handler.call(context)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+      class GetBucketLocationFix < Seahorse::Client::Plugin
+
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            @handler.call(context).on(200) do |response|
+              response.data = S3::Types::GetBucketLocationOutput.new
+              xml = context.http_response.body_contents
+              matches = xml.match(/>(.+?)<\/LocationConstraint>/)
+              response.data[:location_constraint] = matches ? matches[1] : ''
+            end
+          end
+        end
+
+        handler(Handler, priority: 60, operations: [:get_bucket_location])
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/http_200_errors.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+
+      # A handful of Amazon S3 operations will respond with a 200 status
+      # code but will send an error in the response body. This plugin
+      # injects a handler that will parse 200 response bodies for potential
+      # errors, allowing them to be retried.
+      # @api private
+      class Http200Errors < Seahorse::Client::Plugin
+
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            @handler.call(context).on(200) do |response|
+              if error = check_for_error(context)
+                context.http_response.status_code = 500
+                response.data = nil
+                response.error = error
+              end
+            end
+          end
+
+          def check_for_error(context)
+            xml = context.http_response.body_contents
+            if xml.match(/<Error>/)
+              error_code = xml.match(/<Code>(.+?)<\/Code>/)[1]
+              error_message = xml.match(/<Message>(.+?)<\/Message>/)[1]
+              S3::Errors.error_class(error_code).new(context, error_message)
+            elsif !xml.match(/<\w/) # Must have the start of an XML Tag
+              # Other incomplete xml bodies will result in XML ParsingError
+              Seahorse::Client::NetworkingError.new(
+                S3::Errors
+                  .error_class('InternalError')
+                  .new(context, 'Empty or incomplete response body')
+              )
+            end
+          end
+        end
+
+        handler(
+          Handler,
+          step: :sign,
+          operations: [
+            :complete_multipart_upload,
+            :copy_object,
+            :upload_part_copy,
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+
+      class IADRegionalEndpoint < Seahorse::Client::Plugin
+
+        option(:s3_us_east_1_regional_endpoint,
+          default: 'legacy',
+          doc_type: String,
+          docstring: <<-DOCS) do |cfg|
+Passing in `regional` to enable regional endpoint for S3's `us-east-1`
+region. Defaults to `legacy` mode using global endpoint.
+          DOCS
+          resolve_iad_regional_endpoint(cfg)
+        end
+
+        def add_handlers(handlers, config)
+          if config.region == 'us-east-1'
+            handlers.add(Handler)
+          end
+        end
+
+        # @api private
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            # keep legacy global endpoint pattern by default
+            if context.config.s3_us_east_1_regional_endpoint == 'legacy'
+              context.http_request.endpoint.host = IADRegionalEndpoint.legacy_host(
+                context.http_request.endpoint.host)
+            end
+            @handler.call(context)
+          end
+
+        end
+
+        def self.legacy_host(host)
+          host.sub(".us-east-1", '')
+        end
+
+        private
+
+        def self.resolve_iad_regional_endpoint(cfg)
+          mode = ENV['AWS_S3_US_EAST_1_REGIONAL_ENDPOINT'] ||
+            Aws.shared_config.s3_us_east_1_regional_endpoint(profile: cfg.profile) ||
+            'legacy'
+          mode = mode.downcase
+          unless %w(legacy regional).include?(mode)
+            raise ArgumentError, "expected :s3_us_east_1_regional_endpoint or"\
+              " ENV['AWS_S3_US_EAST_1_REGIONAL_ENDPOINT'] to be `legacy` or"\
+              " `regional`."
+          end
+          mode
+        end
+
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/location_constraint.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+
+      # When making calls to {S3::Client#create_bucket} outside the
+      # "classic" region, the bucket location constraint must be specified.
+      # This plugin auto populates the constraint to the configured region.
+      class LocationConstraint < Seahorse::Client::Plugin
+
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            unless context.config.region == 'us-east-1'
+              populate_location_constraint(context.params, context.config.region)
+            end
+            @handler.call(context)
+          end
+
+          private
+
+          def populate_location_constraint(params, region)
+            params[:create_bucket_configuration] ||= {}
+            params[:create_bucket_configuration][:location_constraint] ||= region
+          end
+
+        end
+
+        handler(Handler, step: :initialize, operations: [:create_bucket])
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/md5s.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module Aws
+  module S3
+    module Plugins
+      # @api private
+      # This plugin is effectively deprecated in favor of modeled
+      # httpChecksumRequired traits.
+      class Md5s < Seahorse::Client::Plugin
+        # These operations allow Content MD5 but are not required by
+        # httpChecksumRequired. This list should not grow.
+        OPTIONAL_OPERATIONS = [
+          :put_object,
+          :upload_part
+        ]
+
+        # @api private
+        class Handler < Seahorse::Client::Handler
+
+          CHUNK_SIZE = 1 * 1024 * 1024 # one MB
+
+          def call(context)
+            body = context.http_request.body
+            if body.size > 0
+              context.http_request.headers['Content-Md5'] ||= md5(body)
+            end
+            @handler.call(context)
+          end
+
+          private
+
+          # @param [File, Tempfile, IO#read, String] value
+          # @return [String<MD5>]
+          def md5(value)
+            if (File === value || Tempfile === value) && !value.path.nil? && File.exist?(value.path)
+              OpenSSL::Digest::MD5.file(value).base64digest
+            elsif value.respond_to?(:read)
+              md5 = OpenSSL::Digest::MD5.new
+              update_in_chunks(md5, value)
+              md5.base64digest
+            else
+              OpenSSL::Digest::MD5.digest(value).base64digest
+            end
+          end
+
+          def update_in_chunks(digest, io)
+            loop do
+              chunk = io.read(CHUNK_SIZE)
+              break unless chunk
+              digest.update(chunk)
+            end
+            io.rewind
+          end
+
+        end
+
+        option(:compute_checksums,
+          default: true,
+          doc_type: 'Boolean',
+          docstring: <<-DOCS)
+When `true` a MD5 checksum will be computed and sent in the Content Md5
+header for :put_object and :upload_part. When `false`, MD5 checksums
+will not be computed for these operations. Checksums are still computed
+for operations requiring them. Checksum errors returned by Amazon S3 are
+automatically retried up to `:retry_limit` times.
+          DOCS
+
+        def add_handlers(handlers, config)
+          if config.compute_checksums
+            # priority set low to ensure md5 is computed AFTER the request is
+            # built but before it is signed
+            handlers.add(
+              Handler,
+              priority: 10, step: :build, operations: OPTIONAL_OPERATIONS
+            )
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/redirects.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+      class Redirects < Seahorse::Client::Plugin
+
+        option(:follow_redirects,
+          default: true,
+          doc_type: 'Boolean',
+          docstring: <<-DOCS)
+When `true`, this client will follow 307 redirects returned
+by Amazon S3.
+          DOCS
+
+        # @api private
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            response = @handler.call(context)
+            if context.http_response.status_code == 307
+              endpoint = context.http_response.headers['location']
+              unless context.http_request.endpoint.host.include?('fips')
+                context.http_request.endpoint = endpoint
+              end
+              context.http_response.body.truncate(0)
+              @handler.call(context)
+            else
+              response
+            end
+          end
+
+        end
+
+        def add_handlers(handlers, config)
+          if config.follow_redirects
+            # we want to re-trigger request signing
+            handlers.add(Handler, step: :sign, priority: 90)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/s3_host_id.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Aws
+  module S3
+    module Plugins
+
+      # Support S3 host id, more information, see:
+      # http://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html#sdk-request-ids
+      #
+      # This plugin adds :host_id for s3 responses when available
+      # @api private
+      class S3HostId < Seahorse::Client::Plugin
+
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            response = @handler.call(context)
+            h = context.http_response.headers
+            context[:s3_host_id] = h['x-amz-id-2']
+            response
+          end
+
+        end
+
+        handler(Handler, step: :sign)
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3/plugins/s3_signer.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+require 'aws-sigv4'
+
+module Aws
+  module S3
+    module Plugins
+      # This plugin is an implementation detail and may be modified.
+      # @api private
+      class S3Signer < Seahorse::Client::Plugin
+        option(:signature_version, 'v4')
+
+        option(:sigv4_signer) do |cfg|
+          S3Signer.build_v4_signer(
+            region: cfg.sigv4_region,
+            credentials: cfg.credentials
+          )
+        end
+
+        option(:sigv4_region) do |cfg|
+          raise Aws::Errors::MissingRegionError if cfg.region.nil?
+
+          Aws::Partitions::EndpointProvider.signing_region(cfg.region, 's3')
+        end
+
+        def add_handlers(handlers, cfg)
+          case cfg.signature_version
+          when 'v4' then add_v4_handlers(handlers)
+          when 's3' then add_legacy_handler(handlers)
+          else
+            msg = "unsupported signature version `#{cfg.signature_version}'"
+            raise ArgumentError, msg
+          end
+        end
+
+        def add_v4_handlers(handlers)
+          handlers.add(CachedBucketRegionHandler, step: :sign, priority: 60)
+          handlers.add(V4Handler, step: :sign)
+          handlers.add(BucketRegionErrorHandler, step: :sign, priority: 40)
+        end
+
+        def add_legacy_handler(handlers)
+          handlers.add(LegacyHandler, step: :sign)
+        end
+
+        class LegacyHandler < Seahorse::Client::Handler
+          def call(context)
+            LegacySigner.sign(context)
+            @handler.call(context)
+          end
+        end
+
+        class V4Handler < Seahorse::Client::Handler
+          def call(context)
+            Aws::Plugins::SignatureV4.apply_signature(
+              context: context,
+              signer: sigv4_signer(context)
+            )
+            @handler.call(context)
+          end
+
+          private
+
+          def sigv4_signer(context)
+            # If the client was configured with the wrong region,
+            # we have to build a new signer.
+            if context[:cached_sigv4_region] &&
+               context[:cached_sigv4_region] != context.config.sigv4_signer.region
+              S3Signer.build_v4_signer(
+                region: context[:cached_sigv4_region],
+                credentials: context.config.credentials
+              )
+            else
+              context.config.sigv4_signer
+            end
+          end
+        end
+
+        # This handler will update the http endpoint when the bucket region
+        # is known/cached.
+        class CachedBucketRegionHandler < Seahorse::Client::Handler
+          def call(context)
+            bucket = context.params[:bucket]
+            check_for_cached_region(context, bucket) if bucket
+            @handler.call(context)
+          end
+
+          private
+
+          def check_for_cached_region(context, bucket)
+            cached_region = S3::BUCKET_REGIONS[bucket]
+            if cached_region && cached_region != context.config.region
+              context.http_request.endpoint.host = S3Signer.new_hostname(context, cached_region)
+              context[:cached_sigv4_region] = cached_region
+            end
+          end
+        end
+
+        # This handler detects when a request fails because of a mismatched bucket
+        # region. It follows up by making a request to determine the correct
+        # region, then finally a version 4 signed request against the correct
+        # regional endpoint.
+        class BucketRegionErrorHandler < Seahorse::Client::Handler
+          def call(context)
+            response = @handler.call(context)
+            handle_region_errors(response)
+          end
+
+          private
+
+          def handle_region_errors(response)
+            if wrong_sigv4_region?(response) &&
+               !fips_region?(response) &&
+               !custom_endpoint?(response)
+              get_region_and_retry(response.context)
+            else
+              response
+            end
+          end
+
+          def get_region_and_retry(context)
+            actual_region = context.http_response.headers['x-amz-bucket-region']
+            actual_region ||= region_from_body(context.http_response.body_contents)
+            update_bucket_cache(context, actual_region)
+            log_warning(context, actual_region)
+            resign_with_new_region(context, actual_region)
+            @handler.call(context)
+          end
+
+          def update_bucket_cache(context, actual_region)
+            S3::BUCKET_REGIONS[context.params[:bucket]] = actual_region
+          end
+
+          def fips_region?(resp)
+            resp.context.http_request.endpoint.host.include?('fips')
+          end
+
+          def custom_endpoint?(resp)
+            resolved_suffix = Aws::Partitions::EndpointProvider.dns_suffix_for(
+              resp.context.config.region
+            )
+            !resp.context.http_request.endpoint.hostname.include?(resolved_suffix)
+          end
+
+          def wrong_sigv4_region?(resp)
+            resp.context.http_response.status_code == 400 &&
+              (resp.context.http_response.headers['x-amz-bucket-region'] ||
+               resp.context.http_response.body_contents.match(/<Region>.+?<\/Region>/))
+          end
+
+          def resign_with_new_region(context, actual_region)
+            context.http_response.body.truncate(0)
+            context.http_request.endpoint.host = S3Signer.new_hostname(context, actual_region)
+            context.metadata[:redirect_region] = actual_region
+            Aws::Plugins::SignatureV4.apply_signature(
+              context: context,
+              signer: S3Signer.build_v4_signer(
+                region: actual_region,
+                credentials: context.config.credentials
+              )
+            )
+          end
+
+          def region_from_body(body)
+            region = body.match(/<Region>(.+?)<\/Region>/)[1]
+            if region.nil? || region == ''
+              raise "couldn't get region from body: #{body}"
+            else
+              region
+            end
+          end
+
+          def log_warning(context, actual_region)
+            msg = "S3 client configured for #{context.config.region.inspect} " \
+                  "but the bucket #{context.params[:bucket].inspect} is in " \
+                  "#{actual_region.inspect}; Please configure the proper region " \
+                  "to avoid multiple unnecessary redirects and signing attempts\n"
+            if (logger = context.config.logger)
+              logger.warn(msg)
+            else
+              warn(msg)
+            end
+          end
+        end
+
+        class << self
+          # @option options [required, String] :region
+          # @option options [required, #credentials] :credentials
+          # @api private
+          def build_v4_signer(options = {})
+            Aws::Sigv4::Signer.new(
+              service: 's3',
+              region: options[:region],
+              credentials_provider: options[:credentials],
+              uri_escape_path: false,
+              unsigned_headers: ['content-length', 'x-amzn-trace-id']
+            )
+          end
+
+          def new_hostname(context, region)
+            # Check to see if the bucket is actually an ARN and resolve it
+            # Otherwise it will retry with the ARN as the bucket name.
+            resolved_bucket, resolved_region, arn = BucketARN.resolve_arn!(
+              context.params[:bucket],
+              region,
+              context.config.s3_use_arn_region
+            )
+            uri = URI.parse(
+              Aws::Partitions::EndpointProvider.resolve(resolved_region, 's3')
+            )
+
+            if arn
+              BucketARN.resolve_url!(uri, arn).host
+            else
+              resolved_bucket + '.' + uri.host
+            end
+          end
+        end
+      end
+    end
+  end
+end