aws-sdk-core 3.209.1 → 3.228.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +231 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-defaults/default_configuration.rb +1 -2
  5. data/lib/aws-sdk-core/arn.rb +1 -3
  6. data/lib/aws-sdk-core/assume_role_credentials.rb +1 -0
  7. data/lib/aws-sdk-core/assume_role_web_identity_credentials.rb +1 -0
  8. data/lib/aws-sdk-core/cbor/decoder.rb +0 -2
  9. data/lib/aws-sdk-core/cbor/encoder.rb +2 -2
  10. data/lib/aws-sdk-core/cbor.rb +3 -56
  11. data/lib/aws-sdk-core/client_stubs.rb +29 -55
  12. data/lib/aws-sdk-core/credential_provider.rb +4 -0
  13. data/lib/aws-sdk-core/credential_provider_chain.rb +28 -8
  14. data/lib/aws-sdk-core/credentials.rb +6 -0
  15. data/lib/aws-sdk-core/ecs_credentials.rb +1 -0
  16. data/lib/aws-sdk-core/endpoints/matchers.rb +3 -9
  17. data/lib/aws-sdk-core/endpoints.rb +37 -13
  18. data/lib/aws-sdk-core/error_handler.rb +5 -0
  19. data/lib/aws-sdk-core/errors.rb +2 -2
  20. data/lib/aws-sdk-core/event_emitter.rb +1 -1
  21. data/lib/aws-sdk-core/instance_profile_credentials.rb +147 -157
  22. data/lib/aws-sdk-core/json/error_handler.rb +14 -3
  23. data/lib/aws-sdk-core/json/handler.rb +1 -0
  24. data/lib/aws-sdk-core/log/param_formatter.rb +7 -3
  25. data/lib/aws-sdk-core/plugins/checksum_algorithm.rb +332 -170
  26. data/lib/aws-sdk-core/plugins/client_metrics_plugin.rb +0 -1
  27. data/lib/aws-sdk-core/plugins/credentials_configuration.rb +85 -70
  28. data/lib/aws-sdk-core/plugins/endpoint_pattern.rb +40 -32
  29. data/lib/aws-sdk-core/plugins/http_checksum.rb +2 -8
  30. data/lib/aws-sdk-core/plugins/regional_endpoint.rb +44 -25
  31. data/lib/aws-sdk-core/plugins/sign.rb +30 -21
  32. data/lib/aws-sdk-core/plugins/stub_responses.rb +30 -8
  33. data/lib/aws-sdk-core/plugins/user_agent.rb +33 -2
  34. data/lib/aws-sdk-core/process_credentials.rb +1 -1
  35. data/lib/aws-sdk-core/rest/request/headers.rb +3 -3
  36. data/lib/aws-sdk-core/rpc_v2/builder.rb +1 -1
  37. data/lib/aws-sdk-core/{cbor → rpc_v2}/cbor_engine.rb +4 -5
  38. data/lib/aws-sdk-core/rpc_v2/content_type_handler.rb +3 -1
  39. data/lib/aws-sdk-core/rpc_v2/error_handler.rb +27 -16
  40. data/lib/aws-sdk-core/rpc_v2/handler.rb +2 -1
  41. data/lib/aws-sdk-core/rpc_v2/parser.rb +9 -1
  42. data/lib/aws-sdk-core/rpc_v2.rb +65 -2
  43. data/lib/aws-sdk-core/shared_config.rb +75 -21
  44. data/lib/aws-sdk-core/shared_credentials.rb +1 -0
  45. data/lib/aws-sdk-core/sso_credentials.rb +2 -0
  46. data/lib/aws-sdk-core/static_token_provider.rb +1 -2
  47. data/lib/aws-sdk-core/stubbing/protocols/ec2.rb +12 -11
  48. data/lib/aws-sdk-core/stubbing/protocols/json.rb +11 -10
  49. data/lib/aws-sdk-core/stubbing/protocols/query.rb +7 -6
  50. data/lib/aws-sdk-core/stubbing/protocols/rest.rb +2 -1
  51. data/lib/aws-sdk-core/stubbing/protocols/rest_json.rb +9 -8
  52. data/lib/aws-sdk-core/stubbing/protocols/rest_xml.rb +6 -5
  53. data/lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb +13 -15
  54. data/lib/aws-sdk-core/stubbing.rb +2 -2
  55. data/lib/aws-sdk-core/token.rb +3 -3
  56. data/lib/aws-sdk-core/token_provider.rb +4 -0
  57. data/lib/aws-sdk-core/token_provider_chain.rb +2 -6
  58. data/lib/aws-sdk-core/util.rb +2 -1
  59. data/lib/aws-sdk-core/xml/error_handler.rb +3 -1
  60. data/lib/aws-sdk-sso/client.rb +71 -39
  61. data/lib/aws-sdk-sso/endpoint_parameters.rb +9 -6
  62. data/lib/aws-sdk-sso/endpoint_provider.rb +14 -18
  63. data/lib/aws-sdk-sso/endpoints.rb +2 -42
  64. data/lib/aws-sdk-sso/plugins/endpoints.rb +1 -14
  65. data/lib/aws-sdk-sso.rb +1 -1
  66. data/lib/aws-sdk-ssooidc/client.rb +108 -59
  67. data/lib/aws-sdk-ssooidc/client_api.rb +6 -0
  68. data/lib/aws-sdk-ssooidc/endpoint_parameters.rb +9 -6
  69. data/lib/aws-sdk-ssooidc/endpoint_provider.rb +14 -18
  70. data/lib/aws-sdk-ssooidc/endpoints.rb +2 -42
  71. data/lib/aws-sdk-ssooidc/plugins/endpoints.rb +1 -14
  72. data/lib/aws-sdk-ssooidc/types.rb +48 -16
  73. data/lib/aws-sdk-ssooidc.rb +1 -1
  74. data/lib/aws-sdk-sts/client.rb +279 -91
  75. data/lib/aws-sdk-sts/client_api.rb +33 -8
  76. data/lib/aws-sdk-sts/endpoint_parameters.rb +10 -9
  77. data/lib/aws-sdk-sts/endpoint_provider.rb +50 -55
  78. data/lib/aws-sdk-sts/endpoints.rb +2 -94
  79. data/lib/aws-sdk-sts/errors.rb +15 -0
  80. data/lib/aws-sdk-sts/plugins/endpoints.rb +1 -22
  81. data/lib/aws-sdk-sts/presigner.rb +2 -6
  82. data/lib/aws-sdk-sts/types.rb +170 -28
  83. data/lib/aws-sdk-sts.rb +1 -1
  84. data/lib/seahorse/client/async_base.rb +4 -5
  85. data/lib/seahorse/client/base.rb +0 -14
  86. data/lib/seahorse/client/h2/connection.rb +18 -28
  87. data/lib/seahorse/client/http/response.rb +1 -1
  88. data/lib/seahorse/client/net_http/connection_pool.rb +4 -1
  89. data/lib/seahorse/client/networking_error.rb +1 -1
  90. data/lib/seahorse/client/plugins/h2.rb +4 -4
  91. data/lib/seahorse/client/request_context.rb +2 -2
  92. data/lib/seahorse/client/response.rb +2 -0
  93. data/lib/seahorse/util.rb +2 -1
  94. data/sig/aws-sdk-core/async_client_stubs.rbs +21 -0
  95. data/sig/seahorse/client/async_base.rbs +18 -0
  96. metadata +57 -17
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'cgi'
3
+ require "cgi/escape"
4
+ require "cgi/util" if RUBY_VERSION < "3.5"
4
5
 
5
6
  module Aws
6
7
  module Endpoints
@@ -94,14 +95,7 @@ module Aws
94
95
 
95
96
  # aws.partition(value: string) Option<Partition>
96
97
  def self.aws_partition(value)
97
- partition =
98
- Aws::Partitions.find { |p| p.region?(value) } ||
99
- Aws::Partitions.find { |p| value.match(p.region_regex) } ||
100
- Aws::Partitions.find { |p| p.name == 'aws' }
101
-
102
- return nil unless partition
103
-
104
- partition.metadata
98
+ Aws::Partitions::Metadata.partition(value)
105
99
  end
106
100
 
107
101
  # aws.parseArn(value: string) Option<ARN>
@@ -19,19 +19,28 @@ require 'aws-sigv4'
19
19
  module Aws
20
20
  # @api private
21
21
  module Endpoints
22
- SUPPORTED_AUTH_TRAITS = %w[
23
- aws.auth#sigv4
24
- aws.auth#sigv4a
25
- smithy.api#httpBearerAuth
26
- smithy.api#noAuth
27
- ].freeze
22
+ # Maps config auth scheme preferences to endpoint auth scheme names.
23
+ ENDPOINT_AUTH_PREFERENCE_MAP = {
24
+ 'sigv4' => %w[sigv4 sigv4-s3express],
25
+ 'sigv4a' => ['sigv4a'],
26
+ 'httpBearerAuth' => ['bearer'],
27
+ 'noAuth' => ['none']
28
+ }.freeze
29
+ SUPPORTED_ENDPOINT_AUTH = ENDPOINT_AUTH_PREFERENCE_MAP.values.flatten.freeze
30
+
31
+ # Maps configured auth scheme preferences to modeled auth traits.
32
+ MODELED_AUTH_PREFERENCE_MAP = {
33
+ 'sigv4' => 'aws.auth#sigv4',
34
+ 'sigv4a' => 'aws.auth#sigv4a',
35
+ 'httpBearerAuth' => 'smithy.api#httpBearerAuth',
36
+ 'noAuth' => 'smithy.api#noAuth'
37
+ }.freeze
38
+ SUPPORTED_MODELED_AUTH = MODELED_AUTH_PREFERENCE_MAP.values.freeze
28
39
 
29
40
  class << self
30
41
  def resolve_auth_scheme(context, endpoint)
31
42
  if endpoint && (auth_schemes = endpoint.properties['authSchemes'])
32
- auth_scheme = auth_schemes.find do |scheme|
33
- Aws::Plugins::Sign::SUPPORTED_AUTH_TYPES.include?(scheme['name'])
34
- end
43
+ auth_scheme = endpoint_auth_scheme_preference(auth_schemes, context.config.auth_scheme_preference)
35
44
  raise 'No supported auth scheme for this endpoint.' unless auth_scheme
36
45
 
37
46
  merge_signing_defaults(auth_scheme, context.config)
@@ -42,6 +51,16 @@ module Aws
42
51
 
43
52
  private
44
53
 
54
+ def endpoint_auth_scheme_preference(auth_schemes, preferred_auth)
55
+ ordered_auth = preferred_auth.each_with_object([]) do |pref, list|
56
+ next unless ENDPOINT_AUTH_PREFERENCE_MAP.key?(pref)
57
+
58
+ ENDPOINT_AUTH_PREFERENCE_MAP[pref].each { |name| list << { 'name' => name } }
59
+ end
60
+ ordered_auth += auth_schemes
61
+ ordered_auth.find { |auth| SUPPORTED_ENDPOINT_AUTH.include?(auth['name']) }
62
+ end
63
+
45
64
  def merge_signing_defaults(auth_scheme, config)
46
65
  if %w[sigv4 sigv4a sigv4-s3express].include?(auth_scheme['name'])
47
66
  auth_scheme['signingName'] ||= sigv4_name(config)
@@ -64,13 +83,12 @@ module Aws
64
83
  end
65
84
 
66
85
  def sigv4_name(config)
67
- config.api.metadata['signingName'] ||
68
- config.api.metadata['endpointPrefix']
86
+ config.api.metadata['signingName'] || config.api.metadata['endpointPrefix']
69
87
  end
70
88
 
71
89
  def default_auth_scheme(context)
72
- if (auth_list = default_api_auth(context))
73
- auth = auth_list.find { |a| SUPPORTED_AUTH_TRAITS.include?(a) }
90
+ if (modeled_auth = default_api_auth(context))
91
+ auth = modeled_auth_scheme_preference(modeled_auth, context.config.auth_scheme_preference)
74
92
  case auth
75
93
  when 'aws.auth#sigv4', 'aws.auth#sigv4a'
76
94
  auth_scheme = { 'name' => auth.split('#').last }
@@ -93,6 +111,12 @@ module Aws
93
111
  end
94
112
  end
95
113
 
114
+ def modeled_auth_scheme_preference(modeled_auth, preferred_auth)
115
+ ordered_auth = preferred_auth.map { |pref| MODELED_AUTH_PREFERENCE_MAP[pref] }.compact
116
+ ordered_auth += modeled_auth
117
+ ordered_auth.find { |auth| SUPPORTED_MODELED_AUTH.include?(auth) }
118
+ end
119
+
96
120
  def default_api_auth(context)
97
121
  context.config.api.operation(context.operation_name)['auth'] ||
98
122
  context.config.api.metadata['auth']
@@ -1,12 +1,17 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Aws
4
+ # @api private
4
5
  class ErrorHandler < Seahorse::Client::Handler
5
6
 
6
7
  private
7
8
 
8
9
  def error(context)
9
10
  body = context.http_response.body_contents
11
+ # This is not correct per protocol tests. Some headers will determine the error code.
12
+ # If the body is empty, there is still potentially an error code from the header, but
13
+ # we are making a generic http status error instead. In a new major version, we should
14
+ # always try to extract header, and during extraction, check headers and body.
10
15
  if body.empty?
11
16
  code, message, data = http_status_error(context)
12
17
  else
@@ -68,7 +68,7 @@ module Aws
68
68
  end
69
69
  end
70
70
 
71
- # Rasied when endpoint discovery failed for operations
71
+ # Raised when endpoint discovery failed for operations
72
72
  # that requires endpoints from endpoint discovery
73
73
  class EndpointDiscoveryError < RuntimeError
74
74
  def initialize(*args)
@@ -78,7 +78,7 @@ module Aws
78
78
  end
79
79
  end
80
80
 
81
- # raised when hostLabel member is not provided
81
+ # Raised when hostLabel member is not provided
82
82
  # at operation input when endpoint trait is available
83
83
  # with 'hostPrefix' requirement
84
84
  class MissingEndpointHostLabelValue < RuntimeError
@@ -31,7 +31,7 @@ module Aws
31
31
  def emit(type, params)
32
32
  unless @stream
33
33
  raise Aws::Errors::SignalEventError.new(
34
- "Singaling events before making async request"\
34
+ "Signaling events before making async request"\
35
35
  " is not allowed."
36
36
  )
37
37
  end
@@ -4,11 +4,23 @@ require 'time'
4
4
  require 'net/http'
5
5
 
6
6
  module Aws
7
- # An auto-refreshing credential provider that loads credentials from
8
- # EC2 instances.
7
+ # An auto-refreshing credential provider that loads credentials from EC2 instances.
9
8
  #
10
9
  # instance_credentials = Aws::InstanceProfileCredentials.new
11
10
  # ec2 = Aws::EC2::Client.new(credentials: instance_credentials)
11
+ #
12
+ # ## Retries
13
+ # When initialized from the default credential chain, this provider defaults to `0` retries.
14
+ # Breakdown of retries is as follows:
15
+ #
16
+ # * **Configurable retries** (defaults to `1`): these retries handle errors when communicating
17
+ # with the IMDS endpoint. There are two separate retry mechanisms within the provider:
18
+ # * Entire token fetch and credential retrieval process
19
+ # * Token fetching
20
+ # * **JSON parsing retries**: Fixed at 3 attempts to handle cases when IMDS returns malformed JSON
21
+ # responses. These retries are separate from configurable retries.
22
+ #
23
+ # @see https://docs.aws.amazon.com/sdkref/latest/guide/feature-imds-credentials.html IMDS Credential Provider
12
24
  class InstanceProfileCredentials
13
25
  include CredentialProvider
14
26
  include RefreshingCredentials
@@ -22,10 +34,8 @@ module Aws
22
34
  # @api private
23
35
  class TokenExpiredError < RuntimeError; end
24
36
 
25
- # These are the errors we trap when attempting to talk to the
26
- # instance metadata service. Any of these imply the service
27
- # is not present, no responding or some other non-recoverable
28
- # error.
37
+ # These are the errors we trap when attempting to talk to the instance metadata service.
38
+ # Any of these imply the service is not present, no responding or some other non-recoverable error.
29
39
  # @api private
30
40
  NETWORK_ERRORS = [
31
41
  Errno::EHOSTUNREACH,
@@ -46,99 +56,113 @@ module Aws
46
56
  METADATA_TOKEN_PATH = '/latest/api/token'.freeze
47
57
 
48
58
  # @param [Hash] options
49
- # @option options [Integer] :retries (1) Number of times to retry
50
- # when retrieving credentials.
51
- # @option options [String] :endpoint ('http://169.254.169.254') The IMDS
52
- # endpoint. This option has precedence over the :endpoint_mode.
53
- # @option options [String] :endpoint_mode ('IPv4') The endpoint mode for
54
- # the instance metadata service. This is either 'IPv4' ('169.254.169.254')
55
- # or 'IPv6' ('[fd00:ec2::254]').
56
- # @option options [Boolean] :disable_imds_v1 (false) Disable the use of the
57
- # legacy EC2 Metadata Service v1.
58
- # @option options [String] :ip_address ('169.254.169.254') Deprecated. Use
59
- # :endpoint instead. The IP address for the endpoint.
59
+ # @option options [Integer] :retries (1) Number of times to retry when retrieving credentials.
60
+ # @option options [String] :endpoint ('http://169.254.169.254') The IMDS endpoint. This option has precedence
61
+ # over the `:endpoint_mode`.
62
+ # @option options [String] :endpoint_mode ('IPv4') The endpoint mode for the instance metadata service. This is
63
+ # either 'IPv4' (`169.254.169.254`) or IPv6' (`[fd00:ec2::254]`).
64
+ # @option options [Boolean] :disable_imds_v1 (false) Disable the use of the legacy EC2 Metadata Service v1.
65
+ # @option options [String] :ip_address ('169.254.169.254') Deprecated. Use `:endpoint` instead.
66
+ # The IP address for the endpoint.
60
67
  # @option options [Integer] :port (80)
61
68
  # @option options [Float] :http_open_timeout (1)
62
69
  # @option options [Float] :http_read_timeout (1)
63
- # @option options [Numeric, Proc] :delay By default, failures are retried
64
- # with exponential back-off, i.e. `sleep(1.2 ** num_failures)`. You can
65
- # pass a number of seconds to sleep between failed attempts, or
66
- # a Proc that accepts the number of failures.
67
- # @option options [IO] :http_debug_output (nil) HTTP wire
68
- # traces are sent to this object. You can specify something
69
- # like $stdout.
70
- # @option options [Integer] :token_ttl Time-to-Live in seconds for EC2
71
- # Metadata Token used for fetching Metadata Profile Credentials, defaults
72
- # to 21600 seconds
73
- # @option options [Callable] before_refresh Proc called before
74
- # credentials are refreshed. `before_refresh` is called
75
- # with an instance of this object when
76
- # AWS credentials are required and need to be refreshed.
70
+ # @option options [Numeric, Proc] :delay By default, failures are retried with exponential back-off, i.e.
71
+ # `sleep(1.2 ** num_failures)`. You can pass a number of seconds to sleep between failed attempts, or a Proc
72
+ # that accepts the number of failures.
73
+ # @option options [IO] :http_debug_output (nil) HTTP wire traces are sent to this object.
74
+ # You can specify something like `$stdout`.
75
+ # @option options [Integer] :token_ttl Time-to-Live in seconds for EC2 Metadata Token used for fetching
76
+ # Metadata Profile Credentials, defaults to 21600 seconds.
77
+ # @option options [Callable] :before_refresh Proc called before credentials are refreshed. `before_refresh`
78
+ # is called with an instance of this object when AWS credentials are required and need to be refreshed.
77
79
  def initialize(options = {})
78
- @retries = options[:retries] || 1
79
- endpoint_mode = resolve_endpoint_mode(options)
80
- @endpoint = resolve_endpoint(options, endpoint_mode)
81
- @port = options[:port] || 80
80
+ @backoff = resolve_backoff(options[:backoff])
82
81
  @disable_imds_v1 = resolve_disable_v1(options)
83
- # Flag for if v2 flow fails, skip future attempts
84
- @imds_v1_fallback = false
82
+ @endpoint = resolve_endpoint(options)
85
83
  @http_open_timeout = options[:http_open_timeout] || 1
86
84
  @http_read_timeout = options[:http_read_timeout] || 1
87
85
  @http_debug_output = options[:http_debug_output]
88
- @backoff = backoff(options[:backoff])
86
+ @port = options[:port] || 80
87
+ @retries = options[:retries] || 1
89
88
  @token_ttl = options[:token_ttl] || 21_600
90
- @token = nil
91
- @no_refresh_until = nil
89
+
92
90
  @async_refresh = false
91
+ @imds_v1_fallback = false
92
+ @no_refresh_until = nil
93
+ @token = nil
94
+ @metrics = ['CREDENTIALS_IMDS']
93
95
  super
94
96
  end
95
97
 
96
- # @return [Integer] Number of times to retry when retrieving credentials
97
- # from the instance metadata service. Defaults to 0 when resolving from
98
- # the default credential chain ({Aws::CredentialProviderChain}).
98
+ # @return [Boolean0
99
+ attr_reader :disable_imds_v1
100
+
101
+ # @return [Integer]
102
+ attr_reader :token_ttl
103
+
104
+ # @return [Integer]
99
105
  attr_reader :retries
100
106
 
107
+ # @return [Proc]
108
+ attr_reader :backoff
109
+
110
+ # @return [String]
111
+ attr_reader :endpoint
112
+
113
+ # @return [Integer]
114
+ attr_reader :port
115
+
116
+ # @return [Integer]
117
+ attr_reader :http_open_timeout
118
+
119
+ # @return [Integer]
120
+ attr_reader :http_read_timeout
121
+
122
+ # @return [IO, nil]
123
+ attr_reader :http_debug_output
124
+
101
125
  private
102
126
 
103
127
  def resolve_endpoint_mode(options)
104
- value = options[:endpoint_mode]
105
- value ||= ENV['AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE']
106
- value ||= Aws.shared_config.ec2_metadata_service_endpoint_mode(
107
- profile: options[:profile]
108
- )
109
- value || 'IPv4'
128
+ options[:endpoint_mode] ||
129
+ ENV['AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE'] ||
130
+ Aws.shared_config.ec2_metadata_service_endpoint_mode(profile: options[:profile]) ||
131
+ 'IPv4'
110
132
  end
111
133
 
112
- def resolve_endpoint(options, endpoint_mode)
113
- value = options[:endpoint] || options[:ip_address]
114
- value ||= ENV['AWS_EC2_METADATA_SERVICE_ENDPOINT']
115
- value ||= Aws.shared_config.ec2_metadata_service_endpoint(
116
- profile: options[:profile]
117
- )
134
+ def resolve_endpoint(options)
135
+ if (value = options[:ip_address])
136
+ warn('The `:ip_address` option is deprecated. Use `:endpoint` instead.')
137
+ return value
138
+ end
118
139
 
140
+ value =
141
+ options[:endpoint] ||
142
+ ENV['AWS_EC2_METADATA_SERVICE_ENDPOINT'] ||
143
+ Aws.shared_config.ec2_metadata_service_endpoint(profile: options[:profile]) ||
144
+ nil
119
145
  return value if value
120
146
 
147
+ endpoint_mode = resolve_endpoint_mode(options)
121
148
  case endpoint_mode.downcase
122
149
  when 'ipv4' then 'http://169.254.169.254'
123
150
  when 'ipv6' then 'http://[fd00:ec2::254]'
124
151
  else
125
- raise ArgumentError,
126
- ':endpoint_mode is not valid, expected IPv4 or IPv6, '\
127
- "got: #{endpoint_mode}"
152
+ raise ArgumentError, ":endpoint_mode is not valid, expected IPv4 or IPv6, got: #{endpoint_mode}"
128
153
  end
129
154
  end
130
155
 
131
156
  def resolve_disable_v1(options)
132
- value = options[:disable_imds_v1]
133
- value ||= ENV['AWS_EC2_METADATA_V1_DISABLED']
134
- value ||= Aws.shared_config.ec2_metadata_v1_disabled(
135
- profile: options[:profile]
136
- )
137
- value = value.to_s.downcase if value
138
- Aws::Util.str_2_bool(value) || false
157
+ value =
158
+ options[:disable_imds_v1] ||
159
+ ENV['AWS_EC2_METADATA_V1_DISABLED'] ||
160
+ Aws.shared_config.ec2_metadata_v1_disabled(profile: options[:profile]) ||
161
+ 'false'
162
+ Aws::Util.str_2_bool(value.to_s.downcase)
139
163
  end
140
164
 
141
- def backoff(backoff)
165
+ def resolve_backoff(backoff)
142
166
  case backoff
143
167
  when Proc then backoff
144
168
  when Numeric then ->(_) { sleep(backoff) }
@@ -152,98 +176,74 @@ module Aws
152
176
  return
153
177
  end
154
178
 
155
- # Retry loading credentials up to 3 times is the instance metadata
156
- # service is responding but is returning invalid JSON documents
157
- # in response to the GET profile credentials call.
158
- begin
159
- retry_errors([Aws::Json::ParseError], max_retries: 3) do
160
- c = Aws::Json.load(get_credentials.to_s)
161
- if empty_credentials?(@credentials)
162
- @credentials = Credentials.new(
163
- c['AccessKeyId'],
164
- c['SecretAccessKey'],
165
- c['Token']
166
- )
167
- @expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
168
- if @expiration && @expiration < Time.now
169
- @no_refresh_until = Time.now + refresh_offset
170
- warn_expired_credentials
171
- end
172
- else
173
- # credentials are already set, update them only if the new ones are not empty
174
- if !c['AccessKeyId'] || c['AccessKeyId'].empty?
175
- # error getting new credentials
176
- @no_refresh_until = Time.now + refresh_offset
177
- warn_expired_credentials
178
- else
179
- @credentials = Credentials.new(
180
- c['AccessKeyId'],
181
- c['SecretAccessKey'],
182
- c['Token']
183
- )
184
- @expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
185
- if @expiration && @expiration < Time.now
186
- @no_refresh_until = Time.now + refresh_offset
187
- warn_expired_credentials
188
- end
189
- end
179
+ new_creds =
180
+ begin
181
+ # Retry loading credentials up to 3 times is the instance metadata
182
+ # service is responding but is returning invalid JSON documents
183
+ # in response to the GET profile credentials call.
184
+ retry_errors([Aws::Json::ParseError], max_retries: 3) do
185
+ Aws::Json.load(retrieve_credentials.to_s)
190
186
  end
187
+ rescue Aws::Json::ParseError
188
+ raise Aws::Errors::MetadataParserError
191
189
  end
192
- rescue Aws::Json::ParseError
193
- raise Aws::Errors::MetadataParserError
190
+
191
+ if @credentials&.set? && empty_credentials?(new_creds)
192
+ # credentials are already set, but there was an error getting new credentials
193
+ # so don't update the credentials and use stale ones (static stability)
194
+ @no_refresh_until = Time.now + rand(300..360)
195
+ warn_expired_credentials
196
+ else
197
+ # credentials are empty or successfully retrieved, update them
198
+ update_credentials(new_creds)
194
199
  end
195
200
  end
196
201
 
197
- def get_credentials
202
+ def retrieve_credentials
198
203
  # Retry loading credentials a configurable number of times if
199
204
  # the instance metadata service is not responding.
200
- if _metadata_disabled?
201
- '{}'
202
- else
203
- begin
204
- retry_errors(NETWORK_ERRORS, max_retries: @retries) do
205
- open_connection do |conn|
206
- # attempt to fetch token to start secure flow first
207
- # and rescue to failover
208
- fetch_token(conn) unless @imds_v1_fallback
209
- token = @token.value if token_set?
210
-
211
- # disable insecure flow if we couldn't get token
212
- # and imds v1 is disabled
213
- raise TokenRetrivalError if token.nil? && @disable_imds_v1
214
-
215
- _get_credentials(conn, token)
216
- end
205
+ begin
206
+ retry_errors(NETWORK_ERRORS, max_retries: @retries) do
207
+ open_connection do |conn|
208
+ # attempt to fetch token to start secure flow first
209
+ # and rescue to failover
210
+ fetch_token(conn) unless @imds_v1_fallback || (@token && !@token.expired?)
211
+
212
+ # disable insecure flow if we couldn't get token and imds v1 is disabled
213
+ raise TokenRetrivalError if @token.nil? && @disable_imds_v1
214
+
215
+ fetch_credentials(conn)
217
216
  end
218
- rescue => e
219
- warn("Error retrieving instance profile credentials: #{e}")
220
- '{}'
221
217
  end
218
+ rescue StandardError => e
219
+ warn("Error retrieving instance profile credentials: #{e}")
220
+ '{}'
222
221
  end
223
222
  end
224
223
 
224
+ def update_credentials(creds)
225
+ @credentials = Credentials.new(creds['AccessKeyId'], creds['SecretAccessKey'], creds['Token'])
226
+ @expiration = creds['Expiration'] ? Time.iso8601(creds['Expiration']) : nil
227
+ return unless @expiration && @expiration < Time.now
228
+
229
+ @no_refresh_until = Time.now + rand(300..360)
230
+ warn_expired_credentials
231
+ end
232
+
225
233
  def fetch_token(conn)
226
- retry_errors(NETWORK_ERRORS, max_retries: @retries) do
227
- unless token_set?
228
- created_time = Time.now
229
- token_value, ttl = http_put(
230
- conn, METADATA_TOKEN_PATH, @token_ttl
231
- )
232
- @token = Token.new(token_value, ttl, created_time) if token_value && ttl
233
- end
234
- end
234
+ created_time = Time.now
235
+ token_value, ttl = http_put(conn)
236
+ @token = Token.new(token_value, ttl, created_time) if token_value && ttl
235
237
  rescue *NETWORK_ERRORS
236
238
  # token attempt failed, reset token
237
239
  # fallback to non-token mode
238
- @token = nil
239
240
  @imds_v1_fallback = true
240
241
  end
241
242
 
242
- # token is optional - if nil, uses v1 (insecure) flow
243
- def _get_credentials(conn, token)
244
- metadata = http_get(conn, METADATA_PATH_BASE, token)
243
+ def fetch_credentials(conn)
244
+ metadata = http_get(conn, METADATA_PATH_BASE)
245
245
  profile_name = metadata.lines.first.strip
246
- http_get(conn, METADATA_PATH_BASE + profile_name, token)
246
+ http_get(conn, METADATA_PATH_BASE + profile_name)
247
247
  rescue TokenExpiredError
248
248
  # Token has expired, reset it
249
249
  # The next retry should fetch it
@@ -256,10 +256,6 @@ module Aws
256
256
  @token && !@token.expired?
257
257
  end
258
258
 
259
- def _metadata_disabled?
260
- ENV.fetch('AWS_EC2_METADATA_DISABLED', 'false').downcase == 'true'
261
- end
262
-
263
259
  def open_connection
264
260
  uri = URI.parse(@endpoint)
265
261
  http = Net::HTTP.new(uri.hostname || @endpoint, uri.port || @port)
@@ -271,9 +267,9 @@ module Aws
271
267
  end
272
268
 
273
269
  # GET request fetch profile and credentials
274
- def http_get(connection, path, token = nil)
270
+ def http_get(connection, path)
275
271
  headers = { 'User-Agent' => "aws-sdk-ruby3/#{CORE_GEM_VERSION}" }
276
- headers['x-aws-ec2-metadata-token'] = token if token
272
+ headers['x-aws-ec2-metadata-token'] = @token.value if @token
277
273
  response = connection.request(Net::HTTP::Get.new(path, headers))
278
274
 
279
275
  case response.code.to_i
@@ -287,12 +283,12 @@ module Aws
287
283
  end
288
284
 
289
285
  # PUT request fetch token with ttl
290
- def http_put(connection, path, ttl)
286
+ def http_put(connection)
291
287
  headers = {
292
288
  'User-Agent' => "aws-sdk-ruby3/#{CORE_GEM_VERSION}",
293
- 'x-aws-ec2-metadata-token-ttl-seconds' => ttl.to_s
289
+ 'x-aws-ec2-metadata-token-ttl-seconds' => @token_ttl.to_s
294
290
  }
295
- response = connection.request(Net::HTTP::Put.new(path, headers))
291
+ response = connection.request(Net::HTTP::Put.new(METADATA_TOKEN_PATH, headers))
296
292
  case response.code.to_i
297
293
  when 200
298
294
  [
@@ -321,18 +317,12 @@ module Aws
321
317
  end
322
318
 
323
319
  def warn_expired_credentials
324
- warn("Attempting credential expiration extension due to a credential "\
325
- "service availability issue. A refresh of these credentials "\
326
- "will be attempted again in 5 minutes.")
327
- end
328
-
329
- def empty_credentials?(creds)
330
- !creds || !creds.access_key_id || creds.access_key_id.empty?
320
+ warn('Attempting credential expiration extension due to a credential service availability issue. '\
321
+ 'A refresh of these credentials will be attempted again in 5 minutes.')
331
322
  end
332
323
 
333
- # Compute an offset for refresh with jitter
334
- def refresh_offset
335
- 300 + rand(0..60)
324
+ def empty_credentials?(creds_hash)
325
+ !creds_hash['AccessKeyId'] || creds_hash['AccessKeyId'].empty?
336
326
  end
337
327
 
338
328
  # @api private
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Aws
4
4
  module Json
5
+ # @api private
5
6
  class ErrorHandler < Aws::ErrorHandler
6
7
 
7
8
  def call(context)
@@ -24,17 +25,21 @@ module Aws
24
25
  end
25
26
 
26
27
  def error_code(json, context)
28
+ # This is not correct per protocol tests. awsQueryError is intended to populate the
29
+ # error code of the error class. The error class should come from __type. Query and
30
+ # query compatible services currently have dynamic errors raised from error codes instead
31
+ # of the modeled error class. However, changing this in this major version would break
32
+ # existing usage.
27
33
  code =
28
34
  if aws_query_error?(context)
29
- error = context.http_response.headers['x-amzn-query-error'].split(';')[0]
30
- remove_prefix(error, context)
35
+ aws_query_error_code(context)
31
36
  else
32
37
  json['__type']
33
38
  end
34
39
  code ||= json['code']
35
40
  code ||= context.http_response.headers['x-amzn-errortype']
36
41
  if code
37
- code.split('#').last
42
+ code.split('#').last.split(':').first
38
43
  else
39
44
  http_status_error_code(context)
40
45
  end
@@ -45,6 +50,12 @@ module Aws
45
50
  context.http_response.headers['x-amzn-query-error']
46
51
  end
47
52
 
53
+ def aws_query_error_code(context)
54
+ query_header = context.http_response.headers['x-amzn-query-error']
55
+ error, _type = query_header.split(';') # type not supported
56
+ remove_prefix(error, context)
57
+ end
58
+
48
59
  def remove_prefix(error_code, context)
49
60
  if (prefix = context.config.api.metadata['errorPrefix'])
50
61
  error_code.sub(/^#{prefix}/, '')
@@ -21,6 +21,7 @@ module Aws
21
21
  context.http_request.http_method = 'POST'
22
22
  context.http_request.headers['Content-Type'] = content_type(context)
23
23
  context.http_request.headers['X-Amz-Target'] = target(context)
24
+ context.http_request.headers['X-Amzn-Query-Mode'] = 'true' if query_compatible?(context)
24
25
  context.http_request.body = build_body(context)
25
26
  end
26
27
 
@@ -51,13 +51,17 @@ module Aws
51
51
  when String then summarize_string(value)
52
52
  when Hash then '{' + summarize_hash(value) + '}'
53
53
  when Array then summarize_array(value)
54
- when File then summarize_file(value.path)
55
- when Pathname then summarize_file(value)
54
+ when File then summarize_file(value)
55
+ when Pathname then summarize_filepath(value)
56
56
  else value.inspect
57
57
  end
58
58
  end
59
59
 
60
- def summarize_file(path)
60
+ def summarize_file(file)
61
+ "#<File:#{file.path} (#{file.size} bytes)>"
62
+ end
63
+
64
+ def summarize_filepath(path)
61
65
  "#<File:#{path} (#{File.size(path)} bytes)>"
62
66
  end
63
67