1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
|
# frozen_string_literal: true
require 'time'
require 'net/http'
module Aws
# An auto-refreshing credential provider that loads credentials from
# EC2 instances.
#
# instance_credentials = Aws::InstanceProfileCredentials.new
# ec2 = Aws::EC2::Client.new(credentials: instance_credentials)
class InstanceProfileCredentials
include CredentialProvider
include RefreshingCredentials
# @api private
class Non200Response < RuntimeError; end
# @api private
class TokenRetrivalError < RuntimeError; end
# @api private
class TokenExpiredError < RuntimeError; end
# These are the errors we trap when attempting to talk to the
# instance metadata service. Any of these imply the service
# is not present, no responding or some other non-recoverable
# error.
# @api private
NETWORK_ERRORS = [
Errno::EHOSTUNREACH,
Errno::ECONNREFUSED,
Errno::EHOSTDOWN,
Errno::ENETUNREACH,
SocketError,
Timeout::Error,
Non200Response
].freeze
# Path base for GET request for profile and credentials
# @api private
METADATA_PATH_BASE = '/latest/meta-data/iam/security-credentials/'.freeze
# Path for PUT request for token
# @api private
METADATA_TOKEN_PATH = '/latest/api/token'.freeze
# @param [Hash] options
# @option options [Integer] :retries (1) Number of times to retry
# when retrieving credentials.
# @option options [String] :endpoint ('http://169.254.169.254') The IMDS
# endpoint. This option has precedence over the :endpoint_mode.
# @option options [String] :endpoint_mode ('IPv4') The endpoint mode for
# the instance metadata service. This is either 'IPv4' ('169.254.169.254')
# or 'IPv6' ('[fd00:ec2::254]').
# @option options [String] :ip_address ('169.254.169.254') Deprecated. Use
# :endpoint instead. The IP address for the endpoint.
# @option options [Integer] :port (80)
# @option options [Float] :http_open_timeout (1)
# @option options [Float] :http_read_timeout (1)
# @option options [Numeric, Proc] :delay By default, failures are retried
# with exponential back-off, i.e. `sleep(1.2 ** num_failures)`. You can
# pass a number of seconds to sleep between failed attempts, or
# a Proc that accepts the number of failures.
# @option options [IO] :http_debug_output (nil) HTTP wire
# traces are sent to this object. You can specify something
# like $stdout.
# @option options [Integer] :token_ttl Time-to-Live in seconds for EC2
# Metadata Token used for fetching Metadata Profile Credentials, defaults
# to 21600 seconds
# @option options [Callable] before_refresh Proc called before
# credentials are refreshed. `before_refresh` is called
# with an instance of this object when
# AWS credentials are required and need to be refreshed.
def initialize(options = {})
@retries = options[:retries] || 1
endpoint_mode = resolve_endpoint_mode(options)
@endpoint = resolve_endpoint(options, endpoint_mode)
@port = options[:port] || 80
@http_open_timeout = options[:http_open_timeout] || 1
@http_read_timeout = options[:http_read_timeout] || 1
@http_debug_output = options[:http_debug_output]
@backoff = backoff(options[:backoff])
@token_ttl = options[:token_ttl] || 21_600
@token = nil
@no_refresh_until = nil
@async_refresh = false
super
end
# @return [Integer] Number of times to retry when retrieving credentials
# from the instance metadata service. Defaults to 0 when resolving from
# the default credential chain ({Aws::CredentialProviderChain}).
attr_reader :retries
private
def resolve_endpoint_mode(options)
value = options[:endpoint_mode]
value ||= ENV['AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE']
value ||= Aws.shared_config.ec2_metadata_service_endpoint_mode(
profile: options[:profile]
)
value || 'IPv4'
end
def resolve_endpoint(options, endpoint_mode)
value = options[:endpoint] || options[:ip_address]
value ||= ENV['AWS_EC2_METADATA_SERVICE_ENDPOINT']
value ||= Aws.shared_config.ec2_metadata_service_endpoint(
profile: options[:profile]
)
return value if value
case endpoint_mode.downcase
when 'ipv4' then 'http://169.254.169.254'
when 'ipv6' then 'http://[fd00:ec2::254]'
else
raise ArgumentError,
':endpoint_mode is not valid, expected IPv4 or IPv6, '\
"got: #{endpoint_mode}"
end
end
def backoff(backoff)
case backoff
when Proc then backoff
when Numeric then ->(_) { sleep(backoff) }
else ->(num_failures) { Kernel.sleep(1.2**num_failures) }
end
end
def refresh
if @no_refresh_until && @no_refresh_until > Time.now
warn_expired_credentials
return
end
# Retry loading credentials up to 3 times is the instance metadata
# service is responding but is returning invalid JSON documents
# in response to the GET profile credentials call.
begin
retry_errors([Aws::Json::ParseError, StandardError], max_retries: 3) do
c = Aws::Json.load(get_credentials.to_s)
if empty_credentials?(@credentials)
@credentials = Credentials.new(
c['AccessKeyId'],
c['SecretAccessKey'],
c['Token']
)
@expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
if @expiration && @expiration < Time.now
@no_refresh_until = Time.now + refresh_offset
warn_expired_credentials
end
else
# credentials are already set, update them only if the new ones are not empty
if !c['AccessKeyId'] || c['AccessKeyId'].empty?
# error getting new credentials
@no_refresh_until = Time.now + refresh_offset
warn_expired_credentials
else
@credentials = Credentials.new(
c['AccessKeyId'],
c['SecretAccessKey'],
c['Token']
)
@expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
if @expiration && @expiration < Time.now
@no_refresh_until = Time.now + refresh_offset
warn_expired_credentials
end
end
end
end
rescue Aws::Json::ParseError
raise Aws::Errors::MetadataParserError
end
end
def get_credentials
# Retry loading credentials a configurable number of times if
# the instance metadata service is not responding.
if _metadata_disabled?
'{}'
else
begin
retry_errors(NETWORK_ERRORS, max_retries: @retries) do
open_connection do |conn|
# attempt to fetch token to start secure flow first
# and rescue to failover
begin
retry_errors(NETWORK_ERRORS, max_retries: @retries) do
unless token_set?
created_time = Time.now
token_value, ttl = http_put(
conn, METADATA_TOKEN_PATH, @token_ttl
)
@token = Token.new(token_value, ttl, created_time) if token_value && ttl
end
end
rescue *NETWORK_ERRORS
# token attempt failed, reset token
# fallback to non-token mode
@token = nil
end
token = @token.value if token_set?
begin
metadata = http_get(conn, METADATA_PATH_BASE, token)
profile_name = metadata.lines.first.strip
http_get(conn, METADATA_PATH_BASE + profile_name, token)
rescue TokenExpiredError
# Token has expired, reset it
# The next retry should fetch it
@token = nil
raise Non200Response
end
end
end
rescue
'{}'
end
end
end
def token_set?
@token && !@token.expired?
end
def _metadata_disabled?
ENV.fetch('AWS_EC2_METADATA_DISABLED', 'false').downcase == 'true'
end
def open_connection
uri = URI.parse(@endpoint)
http = Net::HTTP.new(uri.hostname || @endpoint, @port || uri.port)
http.open_timeout = @http_open_timeout
http.read_timeout = @http_read_timeout
http.set_debug_output(@http_debug_output) if @http_debug_output
http.start
yield(http).tap { http.finish }
end
# GET request fetch profile and credentials
def http_get(connection, path, token = nil)
headers = { 'User-Agent' => "aws-sdk-ruby3/#{CORE_GEM_VERSION}" }
headers['x-aws-ec2-metadata-token'] = token if token
response = connection.request(Net::HTTP::Get.new(path, headers))
case response.code.to_i
when 200
response.body
when 401
raise TokenExpiredError
else
raise Non200Response
end
end
# PUT request fetch token with ttl
def http_put(connection, path, ttl)
headers = {
'User-Agent' => "aws-sdk-ruby3/#{CORE_GEM_VERSION}",
'x-aws-ec2-metadata-token-ttl-seconds' => ttl.to_s
}
response = connection.request(Net::HTTP::Put.new(path, headers))
case response.code.to_i
when 200
[
response.body,
response.header['x-aws-ec2-metadata-token-ttl-seconds'].to_i
]
when 400
raise TokenRetrivalError
when 401
raise TokenExpiredError
else
raise Non200Response
end
end
def retry_errors(error_classes, options = {}, &_block)
max_retries = options[:max_retries]
retries = 0
begin
yield
rescue *error_classes
raise unless retries < max_retries
@backoff.call(retries)
retries += 1
retry
end
end
def warn_expired_credentials
warn("Attempting credential expiration extension due to a credential "\
"service availability issue. A refresh of these credentials "\
"will be attempted again in 5 minutes.")
end
def empty_credentials?(creds)
!creds || !creds.access_key_id || creds.access_key_id.empty?
end
# Compute an offset for refresh with jitter
def refresh_offset
300 + rand(0..60)
end
# @api private
# Token used to fetch IMDS profile and credentials
class Token
def initialize(value, ttl, created_time = Time.now)
@ttl = ttl
@value = value
@created_time = created_time
end
# [String] token value
attr_reader :value
def expired?
Time.now - @created_time > @ttl
end
end
end
end
|