aws-partitions 1.329.0 → 1.887.0

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/VERSION

@@ -0,0 +1 @@
+1.887.0

data/lib/aws-partitions/endpoint_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
   module Partitions
     # @api private
@@ -35,53 +37,130 @@ module Aws
       #   "monitoring" for cloudwatch.
       # @param [String] sts_regional_endpoints [STS only] Whether to use
       #   `legacy` (global endpoint for legacy regions) or `regional` mode for
-      #    using regional endpoint for supported regions except 'aws-global'
+      #   using regional endpoint for supported regions except 'aws-global'
+      # @param [Hash] variants Endpoint variants such as 'fips' or 'dualstack'
+      # @option variants [Boolean] :dualstack When true, resolve a dualstack
+      #   endpoint.
+      # @option variants [Boolean] :fips When true, resolve a FIPS endpoint.
       # @api private Use the static class methods instead.
-      def resolve(region, service, sts_regional_endpoints)
-        'https://' + endpoint_for(region, service, sts_regional_endpoints)
+      def resolve(region, service, sts_regional_endpoints, variants)
+        'https://' + endpoint_for(region, service, build_is_global_fn(sts_regional_endpoints), variants)
       end
 
       # @api private Use the static class methods instead.
-      def signing_region(region, service)
-        get_partition(region)
-          .fetch('services', {})
-          .fetch(service, {})
-          .fetch('endpoints', {})
-          .fetch(region, {})
-          .fetch('credentialScope', {})
+      def signing_region(region, service, sts_regional_endpoints)
+        credential_scope(region, service, build_is_global_fn(sts_regional_endpoints))
           .fetch('region', region)
       end
 
       # @api private Use the static class methods instead.
-      def dns_suffix_for(region)
-        get_partition(region)['dnsSuffix']
+      def signing_service(region, service)
+        # don't default to the service name
+        # signers should prefer the api metadata's signingName
+        # if no service is set in the credentialScope
+        credential_scope(region, service, build_is_global_fn('regional'))
+          .fetch('service', nil)
+      end
+
+      # @param [String] region The region used to fetch the partition.
+      # @param [String] service Used only if dualstack is true. Used to find a
+      #   DNS suffix for a specific service.
+      # @param [Hash] variants Endpoint variants such as 'fips' or 'dualstack'
+      # @option variants [Boolean] :dualstack When true, resolve a dualstack
+      #   endpoint.
+      # @option variants [Boolean] :fips When true, resolve a FIPS endpoint.
+      # @api private Use the static class methods instead.
+      def dns_suffix_for(region, service, variants)
+        if configured_variants?(variants)
+          resolve_variant(region, service, variants)['dnsSuffix']
+        else
+          get_partition(region)['dnsSuffix']
+        end
       end
 
       private
 
-      def endpoint_for(region, service, sts_regional_endpoints)
+      def configured_variants?(variants)
+        variants.values.any?
+      end
+
+      def fetch_variant(cfg, tags)
+        variants = cfg.fetch('variants', [])
+        variants.find { |v| tags == Set.new(v['tags']) } || {}
+      end
+
+      def resolve_variant(region, service, config_variants)
+        tags = Set.new(config_variants.select { |_k,v| v == true }.map { |k,_v| k.to_s })
+        is_global_fn = build_is_global_fn # ignore legacy STS config for variants
+
+        partition_cfg = get_partition(region)
+        service_cfg = partition_cfg.fetch('services', {})
+                                   .fetch(service, {})
+
+        endpoints_cfg = service_cfg.fetch('endpoints', {})
+
+        if is_global_fn.call(service, region, endpoints_cfg, service_cfg)
+          region = service_cfg.fetch('partitionEndpoint', region)
+        end
+
+        region_cfg = endpoints_cfg.fetch(region, {})
+        warn_deprecation(service, region) if region_cfg['deprecated']
+
+        partition_defaults = fetch_variant(partition_cfg.fetch('defaults', {}), tags)
+        service_defaults = fetch_variant(service_cfg.fetch('defaults', {}), tags)
+        endpoint_cfg = fetch_variant(region_cfg, tags)
+
+        # merge upwards, preferring values from endpoint > service > partition
+        partition_defaults.merge(service_defaults.merge(endpoint_cfg))
+      end
+
+      def validate_variant!(config_variants, resolved_variant)
+        unless resolved_variant['hostname'] && resolved_variant['dnsSuffix']
+          enabled_variants = config_variants.select { |_k, v| v}.map { |k, _v| k.to_s }.join(', ')
+            raise ArgumentError,
+                "#{enabled_variants} not supported for this region and partition."
+        end
+      end
+
+      def endpoint_for(region, service, is_global_fn, variants)
+        if configured_variants?(variants)
+          endpoint_with_variants_for(region, service, variants)
+        else
+          endpoint_no_variants_for(region, service, is_global_fn)
+        end
+      end
+
+      def endpoint_with_variants_for(region, service, variants)
+        variant = resolve_variant(region, service, variants)
+        validate_variant!(variants, variant)
+        variant['hostname'].sub('{region}', region)
+                           .sub('{service}', service)
+                           .sub('{dnsSuffix}', variant['dnsSuffix'])
+      end
+
+      def endpoint_no_variants_for(region, service, is_global_fn)
         partition = get_partition(region)
         service_cfg = partition.fetch('services', {}).fetch(service, {})
 
         # Find the default endpoint
-        endpoint = service_cfg
+        default_endpoint = service_cfg
                    .fetch('defaults', {})
                    .fetch('hostname', partition['defaults']['hostname'])
 
-        # Check for sts legacy behavior
-        sts_legacy = service == 'sts' &&
-                     sts_regional_endpoints == 'legacy' &&
-                     STS_LEGACY_REGIONS.include?(region)
+        endpoints = service_cfg.fetch('endpoints', {})
 
         # Check for global endpoint.
-        if sts_legacy || service_cfg['isRegionalized'] == false
+        if is_global_fn.call(service, region, endpoints, service_cfg)
           region = service_cfg.fetch('partitionEndpoint', region)
         end
 
         # Check for service/region level endpoint.
-        endpoint = service_cfg
-                   .fetch('endpoints', {})
-                   .fetch(region, {}).fetch('hostname', endpoint)
+        region_cfg = endpoints
+                   .fetch(region, {})
+        endpoint = region_cfg
+                   .fetch('hostname', default_endpoint)
+
+        warn_deprecation(service, region) if region_cfg['deprecated']
 
         # Replace placeholders from the endpoints
         endpoint.sub('{region}', region)
@@ -89,9 +168,51 @@ module Aws
                 .sub('{dnsSuffix}', partition['dnsSuffix'])
       end
 
-      def get_partition(region)
-        partition_containing_region(region) ||
-          partition_matching_region(region) ||
+      def warn_deprecation(service, region)
+        warn("The endpoint for service: #{service}, region: #{region}"\
+             ' is deprecated.')
+      end
+
+      # returns a callable that takes a region
+      # and returns true if the service is global
+      def build_is_global_fn(sts_regional_endpoints='regional')
+        lambda do |service, region, endpoints, service_cfg|
+          # Check for sts legacy behavior
+          sts_legacy = service == 'sts' &&
+            sts_regional_endpoints == 'legacy' &&
+            STS_LEGACY_REGIONS.include?(region)
+
+          is_global = !endpoints.key?(region) &&
+            service_cfg['isRegionalized'] == false
+
+          sts_legacy || is_global
+        end
+      end
+
+      def credential_scope(region, service, is_global_fn)
+        partition = get_partition(region)
+        service_cfg = partition.fetch('services', {})
+                               .fetch(service, {})
+        endpoints = service_cfg.fetch('endpoints', {})
+
+        # Check for global endpoint.
+        if is_global_fn.call(service, region, endpoints, service_cfg)
+          region = service_cfg.fetch('partitionEndpoint', region)
+        end
+
+        default_credential_scope = service_cfg
+                                     .fetch('defaults', {})
+                                     .fetch('credentialScope', {})
+
+        endpoints
+          .fetch(region, {})
+          .fetch('credentialScope', default_credential_scope)
+      end
+
+      def get_partition(region_or_partition)
+        partition_containing_region(region_or_partition) ||
+          partition_matching_region(region_or_partition) ||
+          partition_matching_name(region_or_partition) ||
           default_partition
       end
 
@@ -103,29 +224,37 @@ module Aws
 
       def partition_matching_region(region)
         @rules['partitions'].find do |p|
-          region.match(p['regionRegex']) ||
+          p['regionRegex'] && region.match(p['regionRegex']) ||
             p['services'].values.find do |svc|
               svc['endpoints'].key?(region) if svc.key?('endpoints')
             end
         end
       end
 
+      def partition_matching_name(partition_name)
+        @rules['partitions'].find { |p| p['partition'] == partition_name }
+      end
+
       def default_partition
         @rules['partitions'].find { |p| p['partition'] == 'aws' } ||
           @rules['partitions'].first
       end
 
       class << self
-        def resolve(region, service, sts_regional_endpoints = 'regional')
-          default_provider.resolve(region, service, sts_regional_endpoints)
+        def resolve(region, service, sts_endpoint = 'regional', variants = {})
+          default_provider.resolve(region, service, sts_endpoint, variants)
+        end
+
+        def signing_region(region, service, sts_regional_endpoints = 'regional')
+          default_provider.signing_region(region, service, sts_regional_endpoints)
         end
 
-        def signing_region(region, service)
-          default_provider.signing_region(region, service)
+        def signing_service(region, service)
+          default_provider.signing_service(region, service)
         end
 
-        def dns_suffix_for(region)
-          default_provider.dns_suffix_for(region)
+        def dns_suffix_for(region, service = nil, variants = {})
+          default_provider.dns_suffix_for(region, service, variants)
         end
 
         private

data/lib/aws-partitions/partition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
   module Partitions
     class Partition
@@ -8,12 +10,20 @@ module Aws
       def initialize(options = {})
         @name = options[:name]
         @regions = options[:regions]
+        @region_regex = options[:region_regex]
         @services = options[:services]
+        @metadata = options[:metadata]
       end
 
       # @return [String] The partition name, e.g. "aws", "aws-cn", "aws-us-gov".
       attr_reader :name
 
+      # @return [String] The regex representing the region format.
+      attr_reader :region_regex
+
+      # @return [Metadata] The metadata for the partition.
+      attr_reader :metadata
+
       # @param [String] region_name The name of the region, e.g. "us-east-1".
       # @return [Region]
       # @raise [ArgumentError] Raises `ArgumentError` for unknown region name.
@@ -68,6 +78,7 @@ module Aws
           Partition.new(
             name: partition['partition'],
             regions: build_regions(partition),
+            region_regex: partition['regionRegex'],
             services: build_services(partition)
           )
         end
@@ -77,8 +88,7 @@ module Aws
         # @param [Hash] partition
         # @return [Hash<String,Region>]
         def build_regions(partition)
-          partition['regions'].each_with_object({}) do
-            |(region_name, region), regions|
+          partition['regions'].each_with_object({}) do |(region_name, region), regions|
             next if region_name == "#{partition['partition']}-global"
 
             regions[region_name] = Region.build(

data/lib/aws-partitions/partition_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
   module Partitions
     class PartitionList
@@ -40,12 +42,62 @@ module Aws
         end
       end
 
+      # @param [Partition] partitions_metadata
+      # @api private
+      def merge_metadata(partitions_metadata)
+        partitions_metadata['partitions'].each do |partition_metadata|
+          outputs = partition_metadata['outputs']
+
+          if existing = @partitions[partition_metadata['id']]
+            @partitions[partition_metadata['id']] = Partition.new(
+              name: existing.name,
+              regions: build_metadata_regions(
+                partition_metadata['id'],
+                partition_metadata['regions'],
+                existing),
+              region_regex: partition_metadata['regionRegex'],
+              services: existing.services.each_with_object({}) do |s, services|
+                services[s.name] = s
+              end,
+              metadata: outputs
+            )
+          else
+            @partitions[partition_metadata['id']] = Partition.new(
+              name: partition_metadata['id'],
+              regions: build_metadata_regions(
+                partition_metadata['id'], partition_metadata['regions']
+              ),
+              region_regex: partition_metadata['regionRegex'],
+              services: {},
+              metadata: outputs
+            )
+          end
+        end
+      end
+
       # Removed all partitions.
       # @api private
       def clear
         @partitions = {}
       end
 
+      private
+
+      def build_metadata_regions(partition_name, metadata_regions, existing = nil)
+        metadata_regions.each_with_object({}) do |(region_name, region), regions|
+          if existing && existing.region?(region_name)
+            regions[region_name] = existing.region(region_name)
+          else
+            regions[region_name] = Region.new(
+              name: region_name,
+              description: region['description'],
+              partition_name: partition_name,
+              services: Set.new
+            )
+          end
+        end
+      end
+
       class << self
 
         # @api private

data/lib/aws-partitions/region.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Aws

data/lib/aws-partitions/service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Aws
@@ -14,6 +16,8 @@ module Aws
         @name = options[:name]
         @partition_name = options[:partition_name]
         @regions = options[:regions]
+        @fips_regions = options[:fips_regions]
+        @dualstack_regions = options[:dualstack_regions]
         @regionalized = options[:regionalized]
         @partition_region = options[:partition_region]
       end
@@ -29,6 +33,14 @@ module Aws
       #   Regions are scoped to the partition.
       attr_reader :regions
 
+      # @return [Set<String>] The FIPS compatible regions this service is
+      #   available in. Regions are scoped to the partition.
+      attr_reader :fips_regions
+
+      # @return [Set<String>] The Dualstack compatible regions this service is
+      #   available in. Regions are scoped to the partition.
+      attr_reader :dualstack_regions
+
       # @return [String,nil] The global patition endpoint for this service.
       #   May be `nil`.
       attr_reader :partition_region
@@ -52,6 +64,8 @@ module Aws
             name: service_name,
             partition_name: partition['partition'],
             regions: regions(service, partition),
+            fips_regions: variant_regions('fips', service, partition),
+            dualstack_regions: variant_regions('dualstack', service, partition),
             regionalized: service['isRegionalized'] != false,
             partition_region: partition_region(service)
           )
@@ -65,6 +79,21 @@ module Aws
           names - ["#{partition['partition']}-global"]
         end
 
+        def variant_regions(variant_name, service, partition)
+          svc_endpoints = service.fetch('endpoints', {})
+          names = Set.new
+          svc_endpoints.each do |key, value|
+            variants = value.fetch('variants', [])
+            variants.each do |variant|
+              tags = variant.fetch('tags', [])
+              if tags.include?(variant_name) && partition['regions'].key?(key)
+                names << key
+              end
+            end
+          end
+          names - ["#{partition['partition']}-global"]
+        end
+
         def partition_region(service)
           service['partitionEndpoint']
         end