File: endpoint_provider.rb

package info (click to toggle)
ruby-aws-partitions 1.653.0-3~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 852 kB
  • sloc: ruby: 827; makefile: 5
file content (268 lines) | stat: -rw-r--r-- 9,780 bytes parent folder | download | duplicates (3)
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
# frozen_string_literal: true

module Aws
  module Partitions
    # @api private
    class EndpointProvider
      # When sts_regional_endpoint is set to `legacy`, the endpoint
      # pattern stays global for the following regions:
      STS_LEGACY_REGIONS = %w[
        ap-northeast-1
        ap-south-1
        ap-southeast-1
        ap-southeast-2
        aws-global
        ca-central-1
        eu-central-1
        eu-north-1
        eu-west-1
        eu-west-2
        eu-west-3
        sa-east-1
        us-east-1
        us-east-2
        us-west-1
        us-west-2
      ].freeze

      # Intentionally marked private. The format of the endpoint rules
      # is an implementation detail.
      # @api private
      def initialize(rules)
        @rules = rules
      end

      # @param [String] region The region for the client.
      # @param [String] service The endpoint prefix for the service, e.g.
      #   "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'
      # @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, 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, 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 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 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
        default_endpoint = service_cfg
                   .fetch('defaults', {})
                   .fetch('hostname', partition['defaults']['hostname'])

        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

        # Check for service/region level 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)
                .sub('{service}', service)
                .sub('{dnsSuffix}', partition['dnsSuffix'])
      end

      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

      def partition_containing_region(region)
        @rules['partitions'].find do |p|
          p['regions'].key?(region)
        end
      end

      def partition_matching_region(region)
        @rules['partitions'].find do |p|
          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_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_service(region, service)
          default_provider.signing_service(region, service)
        end

        def dns_suffix_for(region, service = nil, variants = {})
          default_provider.dns_suffix_for(region, service, variants)
        end

        private

        def default_provider
          @default_provider ||= EndpointProvider.new(Partitions.defaults)
        end
      end
    end
  end
end