aws-sdk-core 2.11.212 → 3.170.0

data/lib/aws-sdk-core/plugins/sign.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require 'aws-sigv4'
+
+module Aws
+  module Plugins
+    # @api private
+    class Sign < Seahorse::Client::Plugin
+      # These once had defaults. But now they are used as overrides to
+      # new endpoint and auth resolution.
+      option(:sigv4_signer)
+      option(:sigv4_name)
+      option(:sigv4_region)
+      option(:unsigned_operations, default: [])
+
+      supported_auth_types = %w[sigv4 bearer none]
+      supported_auth_types += ['sigv4a'] if Aws::Sigv4::Signer.use_crt?
+      SUPPORTED_AUTH_TYPES = supported_auth_types.freeze
+
+      def add_handlers(handlers, cfg)
+        operations = cfg.api.operation_names - cfg.unsigned_operations
+        handlers.add(Handler, step: :sign, operations: operations)
+      end
+
+      # @api private
+      # Return a signer with the `sign(context)` method
+      def self.signer_for(auth_scheme, config, region_override = nil)
+        case auth_scheme['name']
+        when 'sigv4', 'sigv4a'
+          SignatureV4.new(auth_scheme, config, region_override)
+        when 'bearer'
+          Bearer.new
+        else
+          NullSigner.new
+        end
+      end
+
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          # Skip signing if using sigv2 signing from s3_signer in S3
+          unless v2_signing?(context.config)
+            signer = Sign.signer_for(
+              context[:auth_scheme],
+              context.config,
+              context[:sigv4_region]
+            )
+            signer.sign(context)
+          end
+          @handler.call(context)
+        end
+
+        private
+
+        def v2_signing?(config)
+          # 's3' is legacy signing, 'v4' is default
+          config.respond_to?(:signature_version) &&
+            config.signature_version == 's3'
+        end
+      end
+
+      # @api private
+      class Bearer
+        def initialize
+        end
+
+        def sign(context)
+          if context.http_request.endpoint.scheme != 'https'
+            raise ArgumentError,
+                  'Unable to use bearer authorization on non https endpoint.'
+          end
+
+          token_provider = context.config.token_provider
+
+          raise Errors::MissingBearerTokenError unless token_provider&.set?
+
+          context.http_request.headers['Authorization'] =
+            "Bearer #{token_provider.token.token}"
+        end
+
+        def presign_url(*args)
+          raise ArgumentError, 'Bearer auth does not support presigned urls'
+        end
+
+        def sign_event(*args)
+          raise ArgumentError, 'Bearer auth does not support event signing'
+        end
+      end
+
+      # @api private
+      class SignatureV4
+        def initialize(auth_scheme, config, region_override = nil)
+          scheme_name = auth_scheme['name']
+
+          unless %w[sigv4 sigv4a].include?(scheme_name)
+            raise ArgumentError,
+                  "Expected sigv4 or sigv4a auth scheme, got #{scheme_name}"
+          end
+
+          region = if scheme_name == 'sigv4a'
+                     auth_scheme['signingRegionSet'].first
+                   else
+                     auth_scheme['signingRegion']
+                   end
+          begin
+            @signer = Aws::Sigv4::Signer.new(
+              service: config.sigv4_name || auth_scheme['signingName'],
+              region: region_override || config.sigv4_region || region,
+              credentials_provider: config.credentials,
+              signing_algorithm: scheme_name.to_sym,
+              uri_escape_path: !!!auth_scheme['disableDoubleEncoding'],
+              unsigned_headers: %w[content-length user-agent x-amzn-trace-id]
+            )
+          rescue Aws::Sigv4::Errors::MissingCredentialsError
+            raise Aws::Errors::MissingCredentialsError
+          end
+        end
+
+        def sign(context)
+          req = context.http_request
+
+          apply_authtype(context, req)
+          reset_signature(req)
+          apply_clock_skew(context, req)
+
+          # compute the signature
+          begin
+            signature = @signer.sign_request(
+              http_method: req.http_method,
+              url: req.endpoint,
+              headers: req.headers,
+              body: req.body
+            )
+          rescue Aws::Sigv4::Errors::MissingCredentialsError
+            # Necessary for when credentials is explicitly set to nil
+            raise Aws::Errors::MissingCredentialsError
+          end
+          # apply signature headers
+          req.headers.update(signature.headers)
+
+          # add request metadata with signature components for debugging
+          context[:canonical_request] = signature.canonical_request
+          context[:string_to_sign] = signature.string_to_sign
+        end
+
+        def presign_url(*args)
+          @signer.presign_url(*args)
+        end
+
+        def sign_event(*args)
+          @signer.sign_event(*args)
+        end
+
+        private
+
+        def apply_authtype(context, req)
+          if context.operation['authtype'].eql?('v4-unsigned-body') &&
+             req.endpoint.scheme.eql?('https')
+            req.headers['X-Amz-Content-Sha256'] ||= 'UNSIGNED-PAYLOAD'
+          end
+        end
+
+        def reset_signature(req)
+          # in case this request is being re-signed
+          req.headers.delete('Authorization')
+          req.headers.delete('X-Amz-Security-Token')
+          req.headers.delete('X-Amz-Date')
+          req.headers.delete('x-Amz-Region-Set')
+        end
+
+        def apply_clock_skew(context, req)
+          if context.config.respond_to?(:clock_skew) &&
+             context.config.clock_skew &&
+             context.config.correct_clock_skew
+
+            endpoint = context.http_request.endpoint
+            skew = context.config.clock_skew.clock_correction(endpoint)
+            if skew.abs.positive?
+              req.headers['X-Amz-Date'] =
+                (Time.now.utc + skew).strftime('%Y%m%dT%H%M%SZ')
+            end
+          end
+        end
+
+      end
+
+      # @api private
+      class NullSigner
+
+        def sign(context)
+        end
+
+        def presign_url(*args)
+        end
+
+        def sign_event(*args)
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/plugins/signature_v2.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Aws
+  module Plugins
+    # @api private
+    # Necessary to keep after Endpoints 2.0
+    class SignatureV2 < Seahorse::Client::Plugin
+
+      option(:v2_signer) do |cfg|
+        Aws::Sigv2::Signer.new(credentials_provider: cfg.credentials)
+      end
+
+      def add_handlers(handlers, _)
+        handlers.add(Handler, step: :sign)
+      end
+
+      class Handler < Seahorse::Client::Handler
+
+        def call(context)
+          apply_signature(
+            context.http_request,
+            context.config.v2_signer
+          )
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_signature(req, signer)
+
+          param_list = req.body.param_list
+          param_list.delete('Timestamp') # in case of re-signing
+
+          signature = signer.sign_request(
+            http_method: req.http_method,
+            url: req.endpoint,
+            params: param_list.inject({}) do |hash, param|
+              hash[param.name] = param.value
+              hash
+            end
+          )
+
+          # apply signature
+          signature.each_pair do |param_name, param_value|
+            param_list.set(param_name, param_value)
+          end
+
+          req.body = param_list.to_io
+
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/plugins/signature_v4.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'aws-sigv4'
+
+module Aws
+  module Plugins
+    # @api private
+    # Necessary to exist after endpoints 2.0
+    class SignatureV4 < Seahorse::Client::Plugin
+
+      V4_AUTH = %w[v4 v4-unsigned-payload v4-unsigned-body]
+
+      option(:sigv4_signer) do |cfg|
+        SignatureV4.build_signer(cfg)
+      end
+
+      option(:sigv4_name) do |cfg|
+        signingName = if cfg.region
+          Aws::Partitions::EndpointProvider.signing_service(
+            cfg.region, cfg.api.metadata['endpointPrefix']
+          )
+        end
+        signingName || cfg.api.metadata['signingName'] || cfg.api.metadata['endpointPrefix']
+      end
+
+      option(:sigv4_region) do |cfg|
+        if cfg.region
+          if cfg.respond_to?(:sts_regional_endpoints)
+            sts_regional = cfg.sts_regional_endpoints
+          end
+          Aws::Partitions::EndpointProvider.signing_region(
+            cfg.region, cfg.api.metadata['endpointPrefix'], sts_regional
+          )
+        end
+      end
+
+      option(:unsigned_operations) do |cfg|
+        if cfg.api.metadata['signatureVersion'] == 'v4'
+          # select operations where authtype is set and is not v4
+          cfg.api.operation_names.select do |o|
+            cfg.api.operation(o)['authtype'] && !V4_AUTH.include?(cfg.api.operation(o)['authtype'])
+          end
+        else # service is not v4 auth
+          # select all operations where authtype is not v4
+          # (includes operations with no explicit authtype)
+          cfg.api.operation_names.select do |o|
+            !V4_AUTH.include?(cfg.api.operation(o)['authtype'])
+          end
+        end
+      end
+
+      def add_handlers(handlers, cfg)
+        if cfg.unsigned_operations.empty?
+          handlers.add(Handler, step: :sign)
+        else
+          operations = cfg.api.operation_names - cfg.unsigned_operations
+          handlers.add(Handler, step: :sign, operations: operations)
+        end
+      end
+
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          SignatureV4.apply_signature(context: context)
+          @handler.call(context)
+        end
+      end
+
+      class MissingCredentialsSigner
+        def sign_request(*args)
+          raise Errors::MissingCredentialsError
+        end
+      end
+
+      class << self
+
+        # @api private
+        def build_signer(cfg)
+          if cfg.credentials && cfg.sigv4_region
+            Aws::Sigv4::Signer.new(
+              service: cfg.sigv4_name,
+              region: cfg.sigv4_region,
+              credentials_provider: cfg.credentials,
+              unsigned_headers: ['content-length', 'user-agent', 'x-amzn-trace-id']
+            )
+          elsif cfg.credentials
+            raise Errors::MissingRegionError
+          elsif cfg.sigv4_region
+            # Instead of raising now, we return a signer that raises only
+            # if you attempt to sign a request. Some services have unsigned
+            # operations and it okay to initialize clients for these services
+            # without credentials. Unsigned operations have an "authtype"
+            # trait of "none".
+            MissingCredentialsSigner.new
+          end
+        end
+
+        # @api private
+        def apply_signature(options = {})
+          context = apply_authtype(options[:context])
+          signer = options[:signer] || context.config.sigv4_signer
+          req = context.http_request
+
+          # in case this request is being re-signed
+          req.headers.delete('Authorization')
+          req.headers.delete('X-Amz-Security-Token')
+          req.headers.delete('X-Amz-Date')
+          req.headers.delete('x-Amz-Region-Set')
+
+          if context.config.respond_to?(:clock_skew) &&
+             context.config.clock_skew &&
+             context.config.correct_clock_skew
+
+            endpoint = context.http_request.endpoint
+            skew = context.config.clock_skew.clock_correction(endpoint)
+            if skew.abs > 0
+              req.headers['X-Amz-Date'] = (Time.now.utc + skew).strftime("%Y%m%dT%H%M%SZ")
+            end
+          end
+
+          # compute the signature
+          begin
+            signature = signer.sign_request(
+              http_method: req.http_method,
+              url: req.endpoint,
+              headers: req.headers,
+              body: req.body
+            )
+          rescue Aws::Sigv4::Errors::MissingCredentialsError
+            raise Aws::Errors::MissingCredentialsError
+          end
+
+          # apply signature headers
+          req.headers.update(signature.headers)
+
+          # add request metadata with signature components for debugging
+          context[:canonical_request] = signature.canonical_request
+          context[:string_to_sign] = signature.string_to_sign
+        end
+
+        # @api private
+        def apply_authtype(context)
+          if context.operation['authtype'].eql?('v4-unsigned-body') &&
+             context.http_request.endpoint.scheme.eql?('https')
+            context.http_request.headers['X-Amz-Content-Sha256'] ||= 'UNSIGNED-PAYLOAD'
+          end
+          context
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/plugins/stub_responses.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 module Aws
   module Plugins
-
-    # @seahorse.client.option [Boolean] :stub_responses (false)
-    #   Causes the client to return stubbed responses. By default
-    #   fake responses are generated and returned. You can specify
-    #   the response data to return or errors to raise by calling
-    #   {ClientStubs#stub_responses}. See {ClientStubs} for more information.
-    #
-    #   ** Please note ** When response stubbing is enabled, no HTTP
-    #   requests are made, and retries are disabled.
-    #
+    # @api private
     class StubResponses < Seahorse::Client::Plugin
 
-      option(:stub_responses, false)
+      option(:stub_responses,
+        default: false,
+        doc_type: 'Boolean',
+        docstring: <<-DOCS)
+Causes the client to return stubbed responses. By default
+fake responses are generated and returned. You can specify
+the response data to return or errors to raise by calling
+{ClientStubs#stub_responses}. See {ClientStubs} for more information.
+
+** Please note ** When response stubbing is enabled, no HTTP
+requests are made, and retries are disabled.
+        DOCS
 
       option(:region) do |config|
         'us-stubbed-1' if config.stub_responses
@@ -32,6 +36,12 @@ module Aws
         if client.config.stub_responses
           client.setup_stubbing
           client.handlers.remove(RetryErrors::Handler)
+          client.handlers.remove(RetryErrors::LegacyHandler)
+          client.handlers.remove(ClientMetricsPlugin::Handler)
+          client.handlers.remove(ClientMetricsSendPlugin::LatencyHandler)
+          client.handlers.remove(ClientMetricsSendPlugin::AttemptHandler)
+          client.handlers.remove(Seahorse::Client::Plugins::RequestCallback::OptionHandler)
+          client.handlers.remove(Seahorse::Client::Plugins::RequestCallback::ReadCallbackHandler)
         end
       end
 
@@ -40,15 +50,22 @@ module Aws
         def call(context)
           stub = context.client.next_stub(context)
           resp = Seahorse::Client::Response.new(context: context)
-          apply_stub(stub, resp)
-          resp
+          async_mode = context.client.is_a? Seahorse::Client::AsyncBase
+          if Hash === stub && stub[:mutex]
+            stub[:mutex].synchronize { apply_stub(stub, resp, async_mode) }
+          else
+            apply_stub(stub, resp, async_mode)
+          end
+
+          async_mode ? Seahorse::Client::AsyncResponse.new(
+            context: context, stream: context[:input_event_stream_handler].event_emitter.stream, sync_queue: Queue.new) : resp
         end
 
-        def apply_stub(stub, response)
+        def apply_stub(stub, response, async_mode = false)
           http_resp = response.context.http_response
           case
           when stub[:error] then signal_error(stub[:error], http_resp)
-          when stub[:http] then signal_http(stub[:http], http_resp)
+          when stub[:http] then signal_http(stub[:http], http_resp, async_mode)
           when stub[:data] then response.data = stub[:data]
           end
         end
@@ -62,9 +79,18 @@ module Aws
         end
 
         # @param [Seahorse::Client::Http::Response] stub
-        # @param [Seahorse::Client::Http::Response] http_resp
-        def signal_http(stub, http_resp)
-          http_resp.signal_headers(stub.status_code, stub.headers.to_h)
+        # @param [Seahorse::Client::Http::Response | Seahorse::Client::Http::AsyncResponse] http_resp
+        # @param [Boolean] async_mode
+        def signal_http(stub, http_resp, async_mode = false)
+          if async_mode
+            h2_headers = stub.headers.to_h.inject([]) do |arr, (k, v)|
+              arr << [k, v]
+            end
+            h2_headers << [":status", stub.status_code]
+            http_resp.signal_headers(h2_headers)
+          else
+            http_resp.signal_headers(stub.status_code, stub.headers.to_h)
+          end
           while chunk = stub.body.read(1024 * 1024)
             http_resp.signal_data(chunk)
           end

data/lib/aws-sdk-core/plugins/transfer_encoding.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Aws
+  module Plugins
+
+    # For Streaming Input Operations, when `requiresLength` is enabled
+    # checking whether `Content-Length` header can be set,
+    # for `v4-unsigned-body` operations, set `Transfer-Encoding` header
+    class TransferEncoding < Seahorse::Client::Plugin
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          if streaming?(context.operation.input)
+            # If it's an IO object and not a File / String / String IO
+            unless context.http_request.body.respond_to?(:size)
+              if requires_length?(context.operation.input)
+                # if size of the IO is not available but required
+                raise Aws::Errors::MissingContentLength.new
+              elsif context.operation['authtype'] == "v4-unsigned-body"
+                context.http_request.headers['Transfer-Encoding'] = 'chunked'
+              end
+            end
+          end
+
+          @handler.call(context)
+        end
+
+        private
+
+        def streaming?(ref)
+          if payload = ref[:payload_member]
+            payload["streaming"] || # checking ref and shape
+              payload.shape["streaming"]
+          else
+            false
+          end
+        end
+
+        def requires_length?(ref)
+          payload = ref[:payload_member]
+          payload["requiresLength"] || # checking ref and shape
+            payload.shape["requiresLength"]
+        end
+
+      end
+
+      handler(Handler, step: :sign)
+
+    end
+
+  end
+end

data/lib/aws-sdk-core/plugins/user_agent.rb

@@ -1,31 +1,46 @@
+# frozen_string_literal: true
+
 module Aws
   module Plugins
+    # @api private
     class UserAgent < Seahorse::Client::Plugin
-
       option(:user_agent_suffix)
 
       # @api private
       class Handler < Seahorse::Client::Handler
-
         def call(context)
           set_user_agent(context)
           @handler.call(context)
         end
 
         def set_user_agent(context)
-          ua = "aws-sdk-ruby2/#{VERSION} %s/%s %s %s" % [
-            (RUBY_ENGINE rescue nil or "ruby"),
-            RUBY_VERSION,
-            RUBY_PLATFORM,
-            context.config.user_agent_suffix,
-          ]
+          ua = "aws-sdk-ruby3/#{CORE_GEM_VERSION}"
+
+          begin
+            ua += " #{RUBY_ENGINE}/#{RUBY_VERSION}"
+          rescue
+            ua += " RUBY_ENGINE_NA/#{RUBY_VERSION}"
+          end
+
+          ua += " #{RUBY_PLATFORM}"
+
+          if context[:gem_name] && context[:gem_version]
+            ua += " #{context[:gem_name]}/#{context[:gem_version]}"
+          end
+
+          if (execution_env = ENV['AWS_EXECUTION_ENV'])
+            ua += " exec-env/#{execution_env}"
+          end
+
+          if context.config.user_agent_suffix
+            ua += " #{context.config.user_agent_suffix}"
+          end
+
           context.http_request.headers['User-Agent'] = ua.strip
         end
-
       end
 
       handler(Handler)
-
     end
   end
 end

data/lib/aws-sdk-core/process_credentials.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Aws
+  # A credential provider that executes a given process and attempts
+  # to read its stdout to recieve a JSON payload containing the credentials.
+  #
+  #     credentials = Aws::ProcessCredentials.new('/usr/bin/credential_proc')
+  #     ec2 = Aws::EC2::Client.new(credentials: credentials)
+  #
+  # Automatically handles refreshing credentials if an Expiration time is
+  # provided in the credentials payload.
+  #
+  # @see https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes
+  class ProcessCredentials
+
+    include CredentialProvider
+    include RefreshingCredentials
+
+    # Creates a new ProcessCredentials object, which allows an
+    # external process to be used as a credential provider.
+    #
+    # @param [String] process Invocation string for process
+    # credentials provider.
+    def initialize(process)
+      @process = process
+      @credentials = credentials_from_process(@process)
+      @async_refresh = false
+
+      super
+    end
+
+    private
+    def credentials_from_process(proc_invocation)
+      begin
+        raw_out = `#{proc_invocation}`
+        process_status = $?
+      rescue Errno::ENOENT
+        raise Errors::InvalidProcessCredentialsPayload.new("Could not find process #{proc_invocation}")
+      end
+
+      if process_status.success?
+        begin
+          creds_json = Aws::Json.load(raw_out)
+        rescue Aws::Json::ParseError
+          raise Errors::InvalidProcessCredentialsPayload.new("Invalid JSON response")
+        end
+        payload_version = creds_json['Version']
+        if payload_version == 1
+          _parse_payload_format_v1(creds_json)
+        else
+          raise Errors::InvalidProcessCredentialsPayload.new("Invalid version #{payload_version} for credentials payload")
+        end
+      else
+        raise Errors::InvalidProcessCredentialsPayload.new('credential_process provider failure, the credential process had non zero exit status and failed to provide credentials')
+      end
+    end
+
+    def _parse_payload_format_v1(creds_json)
+      creds = Credentials.new(
+        creds_json['AccessKeyId'],
+        creds_json['SecretAccessKey'],
+        creds_json['SessionToken']
+      )
+
+      @expiration = creds_json['Expiration'] ? Time.iso8601(creds_json['Expiration']) : nil
+      return creds if creds.set?
+      raise Errors::InvalidProcessCredentialsPayload.new("Invalid payload for JSON credentials version 1")
+    end
+
+    def refresh
+      @credentials = credentials_from_process(@process)
+    end
+
+    def near_expiration?(expiration_length)
+      # are we within 5 minutes of expiration?
+      @expiration && (Time.now.to_i + expiration_length) > @expiration.to_i
+    end
+  end
+end