aws-sdk-core 3.104.4 → 3.109.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 680ba60978f23c0aa45dd61bded4e7f2cc89b45e4edb3604f4ccfe906b5b2e94
-  data.tar.gz: d0332b0ee610e3941c61350863bf49849a24a9ba7ce40e539fca8bf89ad9506b
+  metadata.gz: dbf38b341cf731a1a9fae33006863d5bb82279c1df1ebe898bf610e6c0561eca
+  data.tar.gz: e7e782991bf3d640399a2654b0716496ccf6cbc5b4dd950772032e9999d2774d
 SHA512:
-  metadata.gz: 792e9f570ce9179c26e49265fb2ddc3fbbffa545516dbf69503f5402c6ab036157645c459324ab72be0b217d0f2ae92e97c9cb7e5534f4328d89565a437b0521
-  data.tar.gz: 6480bf69a614e7c8f8e2b3bad0065cf9b50772c24b5e4afdf95b7c1895d1f013d05f4232de50d988bb0ff536f8bb86dd45ad1d9b4a8aa37ca2ced320932db13e
+  metadata.gz: c99c441bbc19e1316a61cdfb1292441a195802986bab00a473e7637ea4d911574a68bee4589989ac84e6e6587467a39a8670d71f640eb90f06d496bb03253415
+  data.tar.gz: '029b522c5c13d47b5e7af30b9f81c80c5057aacf2dfacb89ddfd5e09d992a335806a106615c7b9794966b537d93823f70ba9f65b76f3682d0283fdf19c67a4d7'

data/VERSION

@@ -1 +1 @@
-3.104.4
+3.109.1

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/arn.rb

@@ -75,5 +75,18 @@ module Aws
     def to_s
       "arn:#{partition}:#{service}:#{region}:#{account_id}:#{resource}"
     end
+
+    # Return the ARN as a hash
+    #
+    # @return [Hash]
+    def to_h
+      {
+        partition: @partition,
+        service: @service,
+        region: @region,
+        account_id: @account_id,
+        resource: @resource
+      }
+    end
   end
 end

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/errors.rb

@@ -16,10 +16,10 @@ module Aws
       # @param [Aws::Structure] data
       def initialize(context, message, data = Aws::EmptyStructure.new)
         @code = self.class.code
-        @message = message if message && !message.empty?
         @context = context
         @data = data
-        super(message)
+        @message = message && !message.empty? ? message : self.class
+        super(@message)
       end
 
       # @return [String]
@@ -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/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/plugins/endpoint_pattern.rb

@@ -15,17 +15,18 @@ to default service endpoint when available.
       )
 
       def add_handlers(handlers, config)
-        if config.regional_endpoint && !config.disable_host_prefix_injection
-          handlers.add(Handler, priority: 90)
-        end
+        handlers.add(Handler, priority: 10)
       end
 
       class Handler < Seahorse::Client::Handler
 
         def call(context)
-          endpoint_trait = context.operation.endpoint_pattern
-          if endpoint_trait && !endpoint_trait.empty?
-            _apply_endpoint_trait(context, endpoint_trait)
+          if context.config.regional_endpoint &&
+             !context.config.disable_host_prefix_injection
+            endpoint_trait = context.operation.endpoint_pattern
+            if endpoint_trait && !endpoint_trait.empty?
+              _apply_endpoint_trait(context, endpoint_trait)
+            end
           end
           @handler.call(context)
         end

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

@@ -38,7 +38,7 @@ to test or custom endpoints. This should be a valid HTTP(S) URI.
           end
 
           # check region is a valid RFC host label
-          unless cfg.region =~ /^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{,63}(?<!-)$/
+          unless Seahorse::Util.host_label?(cfg.region)
             raise Errors::InvalidRegionError
           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
@@ -146,6 +160,7 @@ module Aws
 
     config_reader(
       :region,
+      :ca_bundle,
       :credential_process,
       :endpoint_discovery_enabled,
       :max_attempts,
@@ -237,6 +252,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 +290,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

data/lib/aws-sdk-sso.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+unless Module.const_defined?(:Aws)
+  require 'aws-sdk-core'
+  require 'aws-sigv4'
+end
+
+require_relative 'aws-sdk-sso/types'
+require_relative 'aws-sdk-sso/client_api'
+require_relative 'aws-sdk-sso/client'
+require_relative 'aws-sdk-sso/errors'
+require_relative 'aws-sdk-sso/resource'
+require_relative 'aws-sdk-sso/customizations'
+
+# This module provides support for AWS Single Sign-On. This module is available in the
+# `aws-sdk-core` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+#     sso = Aws::SSO::Client.new
+#     resp = sso.get_role_credentials(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Single Sign-On are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::SSO::Errors::ServiceError
+#       # rescues all AWS Single Sign-On API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::SSO
+
+  GEM_VERSION = '3.109.1'
+
+end