aws-sdk-core 3.104.0 → 3.105.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 369aec7f520055c86a23a3582e05e172467fb49c75f96bf14e1a64f56a0e56a6
-  data.tar.gz: d1f709b9bf97a69e831add07882063eb4222b76427972737ab632e45c62e9bec
+  metadata.gz: b8c1b16aa96c3d7072aebb8d050d1ef7ebd252f8830b6113f86787e5db08ad65
+  data.tar.gz: 7044562082f62c1a3c635a358f920ed120353fbd0625e7377e2dd0c16538a248
 SHA512:
-  metadata.gz: 58c5835e6039860ad6214df72d67ac9f2e603bbe3e4b67109e3e351cfecc400449ea1cae41c160a5259093a9c68dc2dd986055b4bb9dc1b7dfa45d4c66b61ff7
-  data.tar.gz: acc26eba763959760d6c8f6c7282378b85e05d309aaa3976b59f1fee834ac3efb263f1b32c910594abeb379cc0e62f217d8ce3a6f414a8c4eacb7ce3a0670282
+  metadata.gz: 1c1d2546c9d2cb8ec8d6545339d5a6ce25afff4dfde771ab9c211e9e11a52d0f5badce17d495ab15211d0a8d39fa8cfd5f9de89b76240d149b2b7da6b307fb1c
+  data.tar.gz: 90522abd2e2839712d101baaccdcf42017063b6d7b8412eb2625b1e751faa8fa0b3c1fc06a547fd92b798fe55f85d5135b24900136fcc8d64fce42ad8bb3c79c

data/VERSION

@@ -1 +1 @@
-3.104.0
+3.105.0

data/lib/aws-sdk-core.rb

@@ -18,9 +18,9 @@ require_relative 'aws-sdk-core/ecs_credentials'
 require_relative 'aws-sdk-core/instance_profile_credentials'
 require_relative 'aws-sdk-core/shared_credentials'
 require_relative 'aws-sdk-core/process_credentials'
+require_relative 'aws-sdk-core/sso_credentials'
 
 # client modules
-
 require_relative 'aws-sdk-core/client_stubs'
 require_relative 'aws-sdk-core/async_client_stubs'
 require_relative 'aws-sdk-core/eager_loader'
@@ -86,10 +86,12 @@ require_relative 'aws-sdk-core/client_side_monitoring/publisher'
 require_relative 'aws-sdk-core/arn'
 require_relative 'aws-sdk-core/arn_parser'
 
-# aws-sdk-sts is vendored to support Aws::AssumeRoleCredentials
-
+# aws-sdk-sts is included to support Aws::AssumeRoleCredentials
 require 'aws-sdk-sts'
 
+# aws-sdk-sso is included to support Aws::SSOCredentials
+require 'aws-sdk-sso'
+
 module Aws
 
   CORE_GEM_VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip

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

@@ -22,11 +22,13 @@ module Aws
       [
         [:static_credentials, {}],
         [:static_profile_assume_role_web_identity_credentials, {}],
+        [:static_profile_sso_credentials, {}],
         [:static_profile_assume_role_credentials, {}],
         [:static_profile_credentials, {}],
         [:static_profile_process_credentials, {}],
         [:env_credentials, {}],
         [:assume_role_web_identity_credentials, {}],
+        [:sso_credentials, {}],
         [:assume_role_credentials, {}],
         [:shared_credentials, {}],
         [:process_credentials, {}],
@@ -57,6 +59,14 @@ module Aws
       end
     end
 
+    def static_profile_sso_credentials(options)
+      if Aws.shared_config.config_enabled? && options[:config] && options[:config].profile
+        Aws.shared_config.sso_credentials_from_config(
+          profile: options[:config].profile
+        )
+      end
+    end
+
     def static_profile_assume_role_credentials(options)
       if Aws.shared_config.config_enabled? && options[:config] && options[:config].profile
         assume_role_with_profile(options, options[:config].profile)
@@ -115,6 +125,15 @@ module Aws
       nil
     end
 
+    def sso_credentials(options)
+      profile_name = determine_profile_name(options)
+      if Aws.shared_config.config_enabled?
+        Aws.shared_config.sso_credentials_from_config(profile: profile_name)
+      end
+    rescue Errors::NoSuchProfileError
+      nil
+    end
+
     def assume_role_credentials(options)
       if Aws.shared_config.config_enabled?
         assume_role_with_profile(options, determine_profile_name(options))

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
 require 'time'
 require 'net/http'
 
@@ -81,8 +80,8 @@ module Aws
       # service is responding but is returning invalid JSON documents
       # in response to the GET profile credentials call.
       begin
-        retry_errors([JSON::ParserError, StandardError], max_retries: 3) do
-          c = JSON.parse(get_credentials.to_s)
+        retry_errors([Aws::Json::ParseError, StandardError], max_retries: 3) do
+          c = Aws::Json.load(get_credentials.to_s)
           @credentials = Credentials.new(
             c['AccessKeyId'],
             c['SecretAccessKey'],
@@ -90,7 +89,7 @@ module Aws
           )
           @expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
         end
-      rescue JSON::ParserError
+      rescue Aws::Json::ParseError
         raise Aws::Errors::MetadataParserError.new
       end
     end

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

@@ -207,6 +207,9 @@ module Aws
     # payload with either invalid version number or malformed contents
     class InvalidProcessCredentialsPayload < RuntimeError; end
 
+    # Raised when SSO Credentials are invalid
+    class InvalidSSOCredentials < RuntimeError; end
+
     # Raised when a client is constructed and region is not specified.
     class MissingRegionError < ArgumentError
       def initialize(*args)

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
 require 'time'
 require 'net/http'
 
@@ -92,8 +91,8 @@ module Aws
       # service is responding but is returning invalid JSON documents
       # in response to the GET profile credentials call.
       begin
-        retry_errors([JSON::ParserError, StandardError], max_retries: 3) do
-          c = JSON.parse(get_credentials.to_s)
+        retry_errors([Aws::Json::ParseError, StandardError], max_retries: 3) do
+          c = Aws::Json.load(get_credentials.to_s)
           @credentials = Credentials.new(
             c['AccessKeyId'],
             c['SecretAccessKey'],
@@ -101,7 +100,7 @@ module Aws
           )
           @expiration = c['Expiration'] ? Time.iso8601(c['Expiration']) : nil
         end
-      rescue JSON::ParserError
+      rescue Aws::Json::ParseError
         raise Aws::Errors::MetadataParserError
       end
     end

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

@@ -39,7 +39,7 @@ module Aws
         require 'oj'
         [
           Oj,
-          [{ mode: :compat, symbol_keys: false }],
+          [{ mode: :compat, symbol_keys: false, empty_string: false }],
           [{ mode: :compat }],
           oj_parse_error
         ]

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

@@ -143,8 +143,22 @@ module Aws
           errors << expected_got(context, "true or false", value)
         end
       when BlobShape
-        unless value.is_a?(String) || io_like?(value)
-          errors << expected_got(context, "a String or IO object", value)
+        unless value.is_a?(String)
+          if streaming_input?(ref)
+            unless io_like?(value, _require_size = false)
+              errors << expected_got(
+                context,
+                "a String or IO like object that supports read and rewind",
+                value
+              )
+            end
+          elsif !io_like?(value, _require_size = true)
+            errors << expected_got(
+              context,
+              "a String or IO like object that supports read, rewind, and size",
+              value
+            )
+          end
         end
       else
         raise "unhandled shape type: #{ref.shape.class.name}"
@@ -167,8 +181,13 @@ module Aws
       end
     end
 
-    def io_like?(value)
-      value.respond_to?(:read) && value.respond_to?(:rewind)
+    def io_like?(value, require_size = true)
+      value.respond_to?(:read) && value.respond_to?(:rewind) &&
+        (!require_size || value.respond_to?(:size))
+    end
+
+    def streaming_input?(ref)
+      (ref["streaming"] || ref.shape["streaming"])
     end
 
     def error_messages(errors)

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

@@ -23,7 +23,7 @@ When provided, `x-api-key` header will be injected with the value provided.
       class OptionHandler < Seahorse::Client::Handler
         def call(context)
           if context.operation.require_apikey
-            if context.params.is_a?(Hash)
+            if context.params.is_a?(Hash) && context.params[:api_key]
               api_key = context.params.delete(:api_key)
             end
             api_key = context.config.api_key if api_key.nil?

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

@@ -30,13 +30,28 @@ following classes:
 * `Aws::Credentials` - Used for configuring static, non-refreshing
   credentials.
 
+* `Aws::SharedCredentials` - Used for loading static credentials from a
+  shared file, such as `~/.aws/config`.
+
+* `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+
+* `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+  assume a role after providing credentials via the web.
+
+* `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+  access token generated from `aws login`.
+
+* `Aws::ProcessCredentials` - Used for loading credentials from a
+  process that outputs to stdout.
+
 * `Aws::InstanceProfileCredentials` - Used for loading credentials
   from an EC2 IMDS on an EC2 instance.
 
-* `Aws::SharedCredentials` - Used for loading credentials from a
-  shared file, such as `~/.aws/config`.
+* `Aws::ECSCredentials` - Used for loading credentials from
+  instances running in ECS.
 
-* `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+* `Aws::CognitoIdentityCredentials` - Used for loading credentials
+  from the Cognito Identity service.
 
 When `:credentials` are not configured directly, the following
 locations will be searched for credentials:
@@ -46,10 +61,10 @@ locations will be searched for credentials:
 * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
 * `~/.aws/credentials`
 * `~/.aws/config`
-* EC2 IMDS instance profile - When used by default, the timeouts are
-  very aggressive. Construct and pass an instance of
-  `Aws::InstanceProfileCredentails` to enable retries and extended
-  timeouts.
+* EC2/ECS IMDS instance profile - When used by default, the timeouts
+  are very aggressive. Construct and pass an instance of
+  `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+  enable retries and extended timeouts.
         DOCS
       ) do |config|
         CredentialProviderChain.new(config).resolve

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

@@ -42,8 +42,8 @@ module Aws
 
       if process_status.success?
         begin
-          creds_json = JSON.parse(raw_out)
-        rescue JSON::ParserError
+          creds_json = Aws::Json.load(raw_out)
+        rescue Aws::Json::ParseError
           raise Errors::InvalidProcessCredentialsPayload.new("Invalid JSON response")
         end
         payload_version = creds_json['Version']

data/lib/aws-sdk-core/rest/response/headers.rb

@@ -2,7 +2,6 @@
 
 require 'time'
 require 'base64'
-require 'json'
 
 module Aws
   module Rest
@@ -68,7 +67,7 @@ module Aws
         end
 
         def extract_json_trait(value)
-          JSON.parse(Base64.decode64(value))
+          Aws::Json.load(Base64.decode64(value))
         end
 
       end

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

@@ -3,6 +3,8 @@
 module Aws
   # @api private
   class SharedConfig
+    SSO_PROFILE_KEYS = %w[sso_start_url sso_region sso_account_id sso_role_name].freeze
+
     # @return [String]
     attr_reader :credentials_path
 
@@ -135,6 +137,18 @@ module Aws
       end
     end
 
+    # Attempts to load from shared config or shared credentials file.
+    # Will always attempt first to load from the shared credentials
+    # file, if present.
+    def sso_credentials_from_config(opts = {})
+      p = opts[:profile] || @profile_name
+      credentials = sso_credentials_from_profile(@parsed_credentials, p)
+      if @parsed_config
+        credentials ||= sso_credentials_from_profile(@parsed_config, p)
+      end
+      credentials
+    end
+
     # Add an accessor method (similar to attr_reader) to return a configuration value
     # Uses the get_config_value below to control where
     # values are loaded from
@@ -237,6 +251,8 @@ module Aws
         provider.credentials if provider.credentials.set?
       elsif (provider = assume_role_process_credentials_from_config(profile))
         provider.credentials if provider.credentials.set?
+      elsif (provider = sso_credentials_from_config(profile: profile))
+        provider.credentials if provider.credentials.set?
       end
     end
 
@@ -273,6 +289,22 @@ module Aws
       end
     end
 
+    # If any of the sso_ profile values are present, attempt to construct
+    # SSOCredentials
+    def sso_credentials_from_profile(cfg, profile)
+      if @parsed_config &&
+         (prof_config = cfg[profile]) &&
+         !(prof_config.keys & SSO_PROFILE_KEYS).empty?
+
+        SSOCredentials.new(
+          sso_start_url: prof_config['sso_start_url'],
+          sso_region: prof_config['sso_region'],
+          sso_account_id: prof_config['sso_account_id'],
+          sso_role_name: prof_config['sso_role_name']
+        )
+      end
+    end
+
     def credentials_from_profile(prof_config)
       creds = Credentials.new(
         prof_config['aws_access_key_id'],

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Aws
+  # An auto-refreshing credential provider that works by assuming a
+  # role via {Aws::SSO::Client#get_role_credentials} using a cached access
+  # token.  This class does NOT implement the SSO login token flow - tokens
+  # must generated and refreshed separately by running `aws login` with the
+  # correct profile.
+  #
+  # For more background on AWS SSO see the official
+  # [what is SSO](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html]
+  # page.
+  #
+  # ## Refreshing Credentials from SSO
+  #
+  # The `SSOCredentials` will auto-refresh the AWS credentials from SSO. In
+  # addition to AWS credentials expiring after a given amount of time, the
+  # access token generated and cached from `aws login` will also expire.
+  # Once this token expires, it will not be usable to refresh AWS credentials,
+  # and another token will be needed. The SDK does not manage refreshing of
+  # the token value, but this can be done by running `aws login` with the
+  # correct profile.
+  class SSOCredentials
+
+    include CredentialProvider
+    include RefreshingCredentials
+
+    SSO_REQUIRED_OPTS = [:sso_account_id, :sso_region, :sso_role_name, :sso_start_url].freeze
+
+    SSO_LOGIN_GUIDANCE = 'The SSO session associated with this profile has '\
+    'expired or is otherwise invalid. To refresh this SSO session run '\
+    'aws sso login with the corresponding profile.'.freeze
+
+    # @option options [required, String] :sso_account_id The AWS account ID
+    #   that temporary AWS credentials will be resolved for
+    #
+    # @option options [required, String] :sso_region The AWS region where the
+    #   SSO directory for the given sso_start_url is hosted.
+    #
+    # @option options [required, String] :sso_role_name The corresponding
+    #   IAM role in the AWS account that temporary AWS credentials
+    #   will be resolved for.
+    #
+    # @option options [required, String] :sso_start_url The start URL is
+    #   provided by the SSO service via the console and is the URL used to
+    #   login to the SSO directory. This is also sometimes referred to as
+    #   the "User Portal URL"
+
+    # @option options [SSO::Client] :client Optional `SSO::Client`.  If not
+    #   provided, a client will be constructed.
+    def initialize(options = {})
+
+      missing_keys = SSO_REQUIRED_OPTS.select { |k| options[k].nil? }
+      unless missing_keys.empty?
+        raise ArgumentError, "Missing required keys: #{missing_keys}"
+      end
+
+      @sso_start_url = options.delete(:sso_start_url)
+      @sso_region = options.delete(:sso_region)
+      @sso_role_name = options.delete(:sso_role_name)
+      @sso_account_id = options.delete(:sso_account_id)
+
+      # validate we can read the token file
+      read_cached_token
+
+      options[:region] = @sso_region
+      options[:credentials] = nil
+      @client = options[:client] || SSO::Client.new(options)
+      super
+    end
+
+    # @return [STS::Client]
+    attr_reader :client
+
+    private
+
+    def read_cached_token
+      cached_token = Json.load(File.read(sso_cache_file))
+      # validation
+      unless cached_token['accessToken'] && cached_token['expiresAt']
+        raise ArgumentError, 'Missing required field(s)'
+      end
+      expires_at = DateTime.parse(cached_token['expiresAt'])
+      if expires_at < DateTime.now
+        raise ArgumentError, 'Cached SSO Token is expired.'
+      end
+      cached_token
+    rescue Aws::Json::ParseError, ArgumentError
+      raise Errors::InvalidSSOCredentials, SSO_LOGIN_GUIDANCE
+    end
+
+    def refresh
+      cached_token = read_cached_token
+      c = @client.get_role_credentials(
+        account_id: @sso_account_id,
+        role_name: @sso_role_name,
+        access_token: cached_token['accessToken']
+      ).role_credentials
+
+      @credentials = Credentials.new(
+        c.access_key_id,
+        c.secret_access_key,
+        c.session_token
+      )
+      @expiration = c.expiration
+    end
+
+    def sso_cache_file
+      start_url_sha1 = OpenSSL::Digest::SHA1.hexdigest(@sso_start_url.encode('utf-8'))
+      File.join(Dir.home, '.aws', 'sso', 'cache', "#{start_url_sha1}.json")
+    rescue ArgumentError
+      # Dir.home raises ArgumentError when ENV['home'] is not set
+      raise ArgumentError, "Unable to load sso_cache_file: ENV['HOME'] is not set."
+    end
+  end
+end