File: signet.rb

package info (click to toggle)
ruby-googleauth 1.16.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 492 kB
  • sloc: ruby: 3,194; makefile: 4
file content (249 lines) | stat: -rw-r--r-- 8,504 bytes parent folder | download
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
# Copyright 2015 Google, Inc.
#
# 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.

require "base64"
require "json"
require "signet/oauth_2/client"
require "googleauth/base_client"
require "googleauth/errors"

module Signet
  # OAuth2 supports OAuth2 authentication.
  module OAuth2
    # Signet::OAuth2::Client creates an OAuth2 client
    #
    # This reopens Client to add #apply and #apply! methods which update a
    # hash with the fetched authentication token.
    class Client
      include Google::Auth::BaseClient

      alias update_token_signet_base update_token!

      def update_token! options = {}
        options = deep_hash_normalize options
        id_token_expires_at = expires_at_from_id_token options[:id_token]
        options[:expires_at] = id_token_expires_at if id_token_expires_at
        update_token_signet_base options
        self.universe_domain = options[:universe_domain] if options.key? :universe_domain
        self
      end

      alias update_signet_base update!
      def update! options = {}
        # Normalize all keys to symbols to allow indifferent access.
        options = deep_hash_normalize options

        # This `update!` method "overide" adds the `@logger`` update and
        # the `universe_domain` update.
        #
        # The `universe_domain` is also updated in `update_token!` but is
        # included here for completeness
        self.universe_domain = options[:universe_domain] if options.key? :universe_domain
        @logger = options[:logger] if options.key? :logger

        update_signet_base options
      end

      def configure_connection options
        @connection_info =
          options[:connection_builder] || options[:default_connection]
        self
      end

      # The token type as symbol, either :id_token or :access_token
      def token_type
        target_audience ? :id_token : :access_token
      end

      # Set the universe domain
      attr_accessor :universe_domain

      alias orig_fetch_access_token! fetch_access_token!
      def fetch_access_token! options = {}
        unless options[:connection]
          connection = build_default_connection
          options = options.merge connection: connection if connection
        end
        info = retry_with_error do
          orig_fetch_access_token! options
        end
        notify_refresh_listeners
        info
      end

      alias googleauth_orig_generate_access_token_request generate_access_token_request
      def generate_access_token_request options = {}
        parameters = googleauth_orig_generate_access_token_request options
        logger&.info do
          Google::Logging::Message.from(
            message: "Requesting access token from #{parameters['grant_type']}",
            "credentialsId" => object_id
          )
        end
        logger&.debug do
          Google::Logging::Message.from(
            message: "Token fetch params: #{parameters}",
            "credentialsId" => object_id
          )
        end
        parameters
      end

      def build_default_connection
        if !defined?(@connection_info)
          nil
        elsif @connection_info.respond_to? :call
          @connection_info.call
        else
          @connection_info
        end
      end

      # rubocop:disable Metrics/MethodLength

      # Retries the provided block with exponential backoff, handling and wrapping errors.
      #
      # @param [Integer] max_retry_count The maximum number of retries before giving up
      # @yield The block to execute and potentially retry
      # @return [Object] The result of the block if successful
      # @raise [Google::Auth::AuthorizationError] If a Signet::AuthorizationError occurs or if retries are exhausted
      # @raise [Google::Auth::ParseError] If a Signet::ParseError occurs during token parsing
      def retry_with_error max_retry_count = 5
        retry_count = 0

        begin
          yield.tap { |resp| log_response resp }
        rescue Signet::AuthorizationError, Signet::ParseError => e
          log_auth_error e
          error_class = e.is_a?(Signet::ParseError) ? Google::Auth::ParseError : Google::Auth::AuthorizationError
          raise error_class.with_details(
            e.message,
            credential_type_name: self.class.name,
            principal: respond_to?(:principal) ? principal : :signet_client
          )
        rescue StandardError => e
          if retry_count < max_retry_count
            log_transient_error e
            retry_count += 1
            sleep retry_count * 0.3
            retry
          else
            log_retries_exhausted e
            msg = "Unexpected error: #{e.inspect}"
            raise Google::Auth::AuthorizationError.with_details(
              msg,
              credential_type_name: self.class.name,
              principal: respond_to?(:principal) ? principal : :signet_client
            )
          end
        end
      end
      # rubocop:enable Metrics/MethodLength

      # Creates a duplicate of these credentials
      # without the Signet::OAuth2::Client-specific
      # transient state (e.g. cached tokens)
      #
      # @param options [Hash] Overrides for the credentials parameters.
      # @see Signet::OAuth2::Client#update!
      def duplicate options = {}
        options = deep_hash_normalize options

        opts = {
          authorization_uri: @authorization_uri,
          token_credential_uri: @token_credential_uri,
          client_id: @client_id,
          client_secret: @client_secret,
          scope: @scope,
          target_audience: @target_audience,
          redirect_uri: @redirect_uri,
          username: @username,
          password: @password,
          issuer: @issuer,
          person: @person,
          sub: @sub,
          audience: @audience,
          signing_key: @signing_key,
          extension_parameters: @extension_parameters,
          additional_parameters: @additional_parameters,
          access_type: @access_type,
          universe_domain: @universe_domain,
          logger: @logger
        }.merge(options)

        new_client = self.class.new opts

        new_client.configure_connection options
      end

      private

      def expires_at_from_id_token id_token
        match = /^[\w=-]+\.([\w=-]+)\.[\w=-]+$/.match id_token.to_s
        return unless match
        json = JSON.parse Base64.urlsafe_decode64 match[1]
        return unless json.key? "exp"
        Time.at json["exp"].to_i
      rescue StandardError
        # Shouldn't happen unless we get a garbled ID token
        nil
      end

      def log_response token_response
        response_hash = JSON.parse token_response rescue {}
        if response_hash["access_token"]
          digest = Digest::SHA256.hexdigest response_hash["access_token"]
          response_hash["access_token"] = "(sha256:#{digest})"
        end
        if response_hash["id_token"]
          digest = Digest::SHA256.hexdigest response_hash["id_token"]
          response_hash["id_token"] = "(sha256:#{digest})"
        end
        logger&.debug do
          Google::Logging::Message.from(
            message: "Received auth token response: #{response_hash}",
            "credentialsId" => object_id
          )
        end
      end

      def log_auth_error err
        logger&.info do
          Google::Logging::Message.from(
            message: "Auth error when fetching auth token: #{err}",
            "credentialsId" => object_id
          )
        end
      end

      def log_transient_error err
        logger&.info do
          Google::Logging::Message.from(
            message: "Transient error when fetching auth token: #{err}",
            "credentialsId" => object_id
          )
        end
      end

      def log_retries_exhausted err
        logger&.info do
          Google::Logging::Message.from(
            message: "Exhausted retries when fetching auth token: #{err}",
            "credentialsId" => object_id
          )
        end
      end
    end
  end
end