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
|
# frozen_string_literal: true
require 'set'
module Aws
# An auto-refreshing credential provider that assumes a role via
# {Aws::STS::Client#assume_role}.
#
# role_credentials = Aws::AssumeRoleCredentials.new(
# client: Aws::STS::Client.new(...),
# role_arn: "linked::account::arn",
# role_session_name: "session-name"
# )
# ec2 = Aws::EC2::Client.new(credentials: role_credentials)
#
# If you omit `:client` option, a new {Aws::STS::Client} object will be
# constructed with additional options that were provided.
#
# @see Aws::STS::Client#assume_role
class AssumeRoleCredentials
include CredentialProvider
include RefreshingCredentials
# @option options [required, String] :role_arn
# @option options [required, String] :role_session_name
# @option options [String] :policy
# @option options [Integer] :duration_seconds
# @option options [String] :external_id
# @option options [STS::Client] :client
# @option options [Callable] before_refresh Proc called before
# credentials are refreshed. Useful for updating tokens.
# `before_refresh` is called when AWS credentials are
# required and need to be refreshed. Tokens can be refreshed using
# the following example:
#
# before_refresh = Proc.new do |assume_role_credentials| do
# assume_role_credentials.assume_role_params['token_code'] = update_token
# end
#
def initialize(options = {})
client_opts = {}
@assume_role_params = {}
options.each_pair do |key, value|
if self.class.assume_role_options.include?(key)
@assume_role_params[key] = value
elsif !CLIENT_EXCLUDE_OPTIONS.include?(key)
client_opts[key] = value
end
end
@client = client_opts[:client] || STS::Client.new(client_opts)
@async_refresh = true
super
end
# @return [STS::Client]
attr_reader :client
# @return [Hash]
attr_reader :assume_role_params
private
def refresh
resp = @client.assume_role(@assume_role_params)
creds = resp.credentials
@credentials = Credentials.new(
creds.access_key_id,
creds.secret_access_key,
creds.session_token,
account_id: parse_account_id(resp)
)
@expiration = creds.expiration
end
def parse_account_id(resp)
arn = resp.assumed_role_user&.arn
ARNParser.parse(arn).account_id if ARNParser.arn?(arn)
end
class << self
# @api private
def assume_role_options
@aro ||= begin
input = STS::Client.api.operation(:assume_role).input
Set.new(input.shape.member_names)
end
end
end
end
end
|