googleauth 1.14.0 → 1.17.0

data/lib/googleauth/service_account.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 require "jwt"
-require "multi_json"
+require "json"
 require "stringio"
 
 require "google/logging/message"
@@ -41,6 +41,10 @@ module Google
       attr_reader :project_id
       attr_reader :quota_project_id
 
+      # @private
+      # @type [::String] The type name for this credential.
+      CREDENTIAL_TYPE_NAME = "service_account".freeze
+
       def enable_self_signed_jwt?
         # Use a self-singed JWT if there's no information that can be used to
         # obtain an OAuth token, OR if there are scopes but also an assertion
@@ -51,23 +55,29 @@ module Google
 
       # Creates a ServiceAccountCredentials.
       #
-      # @param json_key_io [IO] an IO from which the JSON key can be read
+      # @param json_key_io [IO] An IO object containing the JSON key
       # @param scope [string|array|nil] the scope(s) to access
-      def self.make_creds options = {}
+      # @raise [ArgumentError] If both scope and target_audience are specified
+      def self.make_creds options = {} # rubocop:disable Metrics/MethodLength
         json_key_io, scope, enable_self_signed_jwt, target_audience, audience, token_credential_uri =
           options.values_at :json_key_io, :scope, :enable_self_signed_jwt, :target_audience,
                             :audience, :token_credential_uri
         raise ArgumentError, "Cannot specify both scope and target_audience" if scope && target_audience
 
-        if json_key_io
-          private_key, client_email, project_id, quota_project_id, universe_domain = read_json_key json_key_io
-        else
-          private_key = unescape ENV[CredentialsLoader::PRIVATE_KEY_VAR]
-          client_email = ENV[CredentialsLoader::CLIENT_EMAIL_VAR]
-          project_id = ENV[CredentialsLoader::PROJECT_ID_VAR]
-          quota_project_id = nil
-          universe_domain = nil
-        end
+        private_key, client_email, project_id, quota_project_id, universe_domain =
+          if json_key_io
+            json_key = JSON.parse json_key_io.read
+            if json_key.key? "type"
+              json_key_io.rewind
+            else # Defaults to class credential 'type' if missing.
+              json_key["type"] = CREDENTIAL_TYPE_NAME
+              json_key_io = StringIO.new JSON.generate(json_key)
+            end
+            CredentialsLoader.load_and_verify_json_key_type json_key_io, CREDENTIAL_TYPE_NAME
+            read_json_key json_key_io
+          else
+            creds_from_env
+          end
         project_id ||= CredentialsLoader.load_gcloud_project_id
 
         new(token_credential_uri:   token_credential_uri || TOKEN_CRED_URI,
@@ -110,6 +120,9 @@ module Google
       # Handles certain escape sequences that sometimes appear in input.
       # Specifically, interprets the "\n" sequence for newline, and removes
       # enclosing quotes.
+      #
+      # @param str [String] The string to unescape
+      # @return [String] The unescaped string
       def self.unescape str
         str = str.gsub '\n', "\n"
         str = str[1..-2] if str.start_with?('"') && str.end_with?('"')
@@ -164,21 +177,42 @@ module Google
         self
       end
 
+      # Returns the client email as the principal for service account credentials
+      # @private
+      # @return [String] the email address of the service account
+      def principal
+        @issuer
+      end
+
       private
 
       def apply_self_signed_jwt! a_hash
         # Use the ServiceAccountJwtHeaderCredentials using the same cred values
-        cred_json = {
-          private_key: @signing_key.to_s,
-          client_email: @issuer,
-          project_id: @project_id,
-          quota_project_id: @quota_project_id
-        }
-        key_io = StringIO.new MultiJson.dump(cred_json)
-        alt = ServiceAccountJwtHeaderCredentials.make_creds json_key_io: key_io, scope: scope
-        alt.logger = logger
+        alt = ServiceAccountJwtHeaderCredentials.new(
+          private_key:      @signing_key.to_s,
+          issuer:           @issuer,
+          project_id:       @project_id,
+          quota_project_id: @quota_project_id,
+          universe_domain:  universe_domain,
+          scope:            scope,
+          logger:           logger
+        )
         alt.apply! a_hash
       end
+
+      # @private
+      # Loads service account credential details from environment variables.
+      #
+      # @return [Array<String, String, String, nil, nil>] An array containing private_key,
+      #   client_email, project_id, quota_project_id, and universe_domain.
+      def self.creds_from_env
+        private_key = unescape ENV[CredentialsLoader::PRIVATE_KEY_VAR]
+        client_email = ENV[CredentialsLoader::CLIENT_EMAIL_VAR]
+        project_id = ENV[CredentialsLoader::PROJECT_ID_VAR]
+        [private_key, client_email, project_id, nil, nil]
+      end
+
+      private_class_method :creds_from_env
     end
   end
 end

data/lib/googleauth/service_account_jwt_header.rb

@@ -47,7 +47,7 @@ module Google
 
       # Create a ServiceAccountJwtHeaderCredentials.
       #
-      # @param json_key_io [IO] an IO from which the JSON key can be read
+      # @param json_key_io [IO] An IO object containing the JSON key
       # @param scope [string|array|nil] the scope(s) to access
       def self.make_creds options = {}
         json_key_io, scope = options.values_at :json_key_io, :scope
@@ -56,7 +56,7 @@ module Google
 
       # Initializes a ServiceAccountJwtHeaderCredentials.
       #
-      # @param json_key_io [IO] an IO from which the JSON key can be read
+      # @param json_key_io [IO] An IO object containing the JSON key
       def initialize options = {}
         json_key_io = options[:json_key_io]
         if json_key_io
@@ -159,6 +159,13 @@ module Google
         false
       end
 
+      # Returns the client email as the principal for service account JWT header credentials
+      # @private
+      # @return [String] the email address of the service account
+      def principal
+        @issuer
+      end
+
       private
 
       def deep_hash_normalize old_hash

data/lib/googleauth/signet.rb

@@ -16,6 +16,7 @@ require "base64"
 require "json"
 require "signet/oauth_2/client"
 require "googleauth/base_client"
+require "googleauth/errors"
 
 module Signet
   # OAuth2 supports OAuth2 authentication.
@@ -109,17 +110,29 @@ module Signet
         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 e.is_a?(Signet::AuthorizationError) || e.is_a?(Signet::ParseError)
-            log_auth_error e
-            raise e
-          end
-
           if retry_count < max_retry_count
             log_transient_error e
             retry_count += 1
@@ -128,10 +141,15 @@ module Signet
           else
             log_retries_exhausted e
             msg = "Unexpected error: #{e.inspect}"
-            raise Signet::AuthorizationError, msg
+            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
@@ -192,10 +210,12 @@ module Signet
           digest = Digest::SHA256.hexdigest response_hash["id_token"]
           response_hash["id_token"] = "(sha256:#{digest})"
         end
-        Google::Logging::Message.from(
-          message: "Received auth token response: #{response_hash}",
-          "credentialsId" => object_id
-        )
+        logger&.debug do
+          Google::Logging::Message.from(
+            message: "Received auth token response: #{response_hash}",
+            "credentialsId" => object_id
+          )
+        end
       end
 
       def log_auth_error err

data/lib/googleauth/user_authorizer.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 require "uri"
-require "multi_json"
+require "json"
 require "googleauth/signet"
 require "googleauth/user_refresh"
 require "securerandom"
@@ -63,12 +63,14 @@ module Google
       # @param [String] code_verifier
       #  Random string of 43-128 chars used to verify the key exchange using
       #  PKCE.
+      # @raise [Google::Auth::InitializationError]
+      #  If client_id is nil or scope is nil
       def initialize client_id, scope, token_store,
                      legacy_callback_uri = nil,
                      callback_uri: nil,
                      code_verifier: nil
-        raise NIL_CLIENT_ID_ERROR if client_id.nil?
-        raise NIL_SCOPE_ERROR if scope.nil?
+        raise InitializationError, NIL_CLIENT_ID_ERROR if client_id.nil?
+        raise InitializationError, NIL_SCOPE_ERROR if scope.nil?
 
         @client_id = client_id
         @scope = Array(scope)
@@ -133,14 +135,19 @@ module Google
       #  the requested scopes
       # @return [Google::Auth::UserRefreshCredentials]
       #  Stored credentials, nil if none present
+      # @raise [Google::Auth::CredentialsError]
+      #  If the client ID in the stored token doesn't match the configured client ID
       def get_credentials user_id, scope = nil
         saved_token = stored_token user_id
         return nil if saved_token.nil?
-        data = MultiJson.load saved_token
+        data = JSON.parse saved_token
 
         if data.fetch("client_id", @client_id.id) != @client_id.id
-          raise format(MISMATCHED_CLIENT_ID_ERROR,
-                       data["client_id"], @client_id.id)
+          raise CredentialsError.with_details(
+            format(MISMATCHED_CLIENT_ID_ERROR, data["client_id"], @client_id.id),
+            credential_type_name: self.class.name,
+            principal: principal
+          )
         end
 
         credentials = UserRefreshCredentials.new(
@@ -240,8 +247,10 @@ module Google
       #  Unique ID of the user for loading/storing credentials.
       # @param [Google::Auth::UserRefreshCredentials] credentials
       #  Credentials to store.
+      # @return [Google::Auth::UserRefreshCredentials]
+      #  The stored credentials
       def store_credentials user_id, credentials
-        json = MultiJson.dump(
+        json = JSON.generate(
           client_id:              credentials.client_id,
           access_token:           credentials.access_token,
           refresh_token:          credentials.refresh_token,
@@ -269,6 +278,15 @@ module Google
         SecureRandom.alphanumeric random_number
       end
 
+      # Returns the principal identifier for this authorizer
+      # The client ID is used as the principal for user authorizers
+      #
+      # @private
+      # @return [String] The client ID associated with this authorizer
+      def principal
+        @client_id.id
+      end
+
       private
 
       # @private Fetch stored token with given user_id
@@ -276,9 +294,11 @@ module Google
       # @param [String] user_id
       #  Unique ID of the user for loading/storing credentials.
       # @return [String] The saved token from @token_store
+      # @raise [Google::Auth::InitializationError]
+      #  If user_id is nil or token_store is nil
       def stored_token user_id
-        raise NIL_USER_ID_ERROR if user_id.nil?
-        raise NIL_TOKEN_STORE_ERROR if @token_store.nil?
+        raise InitializationError, NIL_USER_ID_ERROR if user_id.nil?
+        raise InitializationError, NIL_TOKEN_STORE_ERROR if @token_store.nil?
 
         @token_store.load user_id
       end
@@ -303,9 +323,17 @@ module Google
       #  Absolute URL to resolve the callback against if necessary.
       # @return [String]
       #  Redirect URI
+      # @raise [Google::Auth::CredentialsError]
+      #  If the callback URI is relative and base_url is nil or not absolute
       def redirect_uri_for base_url
         return @callback_uri if uri_is_postmessage?(@callback_uri) || !URI(@callback_uri).scheme.nil?
-        raise format(MISSING_ABSOLUTE_URL_ERROR, @callback_uri) if base_url.nil? || URI(base_url).scheme.nil?
+        if base_url.nil? || URI(base_url).scheme.nil?
+          raise CredentialsError.with_details(
+            format(MISSING_ABSOLUTE_URL_ERROR, @callback_uri),
+            credential_type_name: self.class.name,
+            principal: principal
+          )
+        end
         URI.join(base_url, @callback_uri).to_s
       end
 

data/lib/googleauth/user_refresh.rb

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "googleauth/signet"
 require "googleauth/credentials_loader"
+require "googleauth/errors"
 require "googleauth/scope_util"
-require "multi_json"
+require "googleauth/signet"
+require "json"
 
 module Google
   # Module Auth provides classes that provide Google-specific authorization
@@ -38,21 +39,36 @@ module Google
       attr_reader :project_id
       attr_reader :quota_project_id
 
+      # @private
+      # @type [::String] The type name for this credential.
+      CREDENTIAL_TYPE_NAME = "authorized_user".freeze
+
       # Create a UserRefreshCredentials.
       #
-      # @param json_key_io [IO] an IO from which the JSON key can be read
+      # @param json_key_io [IO] An IO object containing the JSON key
       # @param scope [string|array|nil] the scope(s) to access
-      def self.make_creds options = {}
+      def self.make_creds options = {} # rubocop:disable Metrics/MethodLength
         json_key_io, scope = options.values_at :json_key_io, :scope
-        user_creds = read_json_key json_key_io if json_key_io
-        user_creds ||= {
-          "client_id"     => ENV[CredentialsLoader::CLIENT_ID_VAR],
-          "client_secret" => ENV[CredentialsLoader::CLIENT_SECRET_VAR],
-          "refresh_token" => ENV[CredentialsLoader::REFRESH_TOKEN_VAR],
-          "project_id"    => ENV[CredentialsLoader::PROJECT_ID_VAR],
-          "quota_project_id" => nil,
-          "universe_domain" => nil
-        }
+        user_creds = if json_key_io
+                       json_key = JSON.parse json_key_io.read
+                       if json_key.key? "type"
+                         json_key_io.rewind
+                       else # Defaults to class credential 'type' if missing.
+                         json_key["type"] = CREDENTIAL_TYPE_NAME
+                         json_key_io = StringIO.new JSON.generate(json_key)
+                       end
+                       CredentialsLoader.load_and_verify_json_key_type json_key_io, CREDENTIAL_TYPE_NAME
+                       read_json_key json_key_io
+                     else
+                       {
+                         "client_id"     => ENV[CredentialsLoader::CLIENT_ID_VAR],
+                         "client_secret" => ENV[CredentialsLoader::CLIENT_SECRET_VAR],
+                         "refresh_token" => ENV[CredentialsLoader::REFRESH_TOKEN_VAR],
+                         "project_id"    => ENV[CredentialsLoader::PROJECT_ID_VAR],
+                         "quota_project_id" => nil,
+                         "universe_domain" => nil
+                       }
+                     end
         new(token_credential_uri: TOKEN_CRED_URI,
             client_id:            user_creds["client_id"],
             client_secret:        user_creds["client_secret"],
@@ -64,13 +80,16 @@ module Google
           .configure_connection(options)
       end
 
-      # Reads the client_id, client_secret and refresh_token fields from the
-      # JSON key.
+      # Reads a JSON key from an IO object and extracts required fields.
+      #
+      # @param [IO] json_key_io An IO object containing the JSON key
+      # @return [Hash] The parsed JSON key
+      # @raise [Google::Auth::InitializationError] If the JSON is missing required fields
       def self.read_json_key json_key_io
-        json_key = MultiJson.load json_key_io.read
+        json_key = JSON.parse json_key_io.read
         wanted = ["client_id", "client_secret", "refresh_token"]
         wanted.each do |key|
-          raise "the json is missing the #{key} field" unless json_key.key? key
+          raise InitializationError, "the json is missing the #{key} field" unless json_key.key? key
         end
         json_key
       end
@@ -106,6 +125,10 @@ module Google
       end
 
       # Revokes the credential
+      #
+      # @param [Hash] options Options for revoking the credential
+      # @option options [Faraday::Connection] :connection The connection to use
+      # @raise [Google::Auth::AuthorizationError] If the revocation request fails
       def revoke! options = {}
         c = options[:connection] || Faraday.default_connection
 
@@ -117,9 +140,14 @@ module Google
             self.refresh_token = nil
             self.expires_at = 0
           else
-            raise(Signet::AuthorizationError,
-                  "Unexpected error code #{resp.status}")
+            raise AuthorizationError.with_details(
+              "Unexpected error code #{resp.status}",
+              credential_type_name: self.class.name,
+              principal: principal
+            )
           end
+
+          resp.body
         end
       end
 
@@ -157,6 +185,13 @@ module Google
 
         self
       end
+
+      # Returns the client ID as the principal for user refresh credentials
+      # @private
+      # @return [String, Symbol] the client ID or :user_refresh if not available
+      def principal
+        @client_id || :user_refresh
+      end
     end
   end
 end

data/lib/googleauth/version.rb

@@ -16,6 +16,6 @@ module Google
   # Module Auth provides classes that provide Google-specific authorization
   # used to access Google APIs.
   module Auth
-    VERSION = "1.14.0".freeze
+    VERSION = "1.17.0".freeze
   end
 end

data/lib/googleauth/web_user_authorizer.rb

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "multi_json"
+require "json"
+require "googleauth/errors"
 require "googleauth/signet"
 require "googleauth/user_authorizer"
 require "googleauth/user_refresh"
@@ -79,9 +80,11 @@ module Google
       #
       # @param [Rack::Request] request
       #  Current request
+      # @return [String, nil]
+      #  Redirect URI if successfully extracted, nil otherwise
       def self.handle_auth_callback_deferred request
         callback_state, redirect_uri = extract_callback_state request
-        request.session[CALLBACK_STATE_KEY] = MultiJson.dump callback_state
+        request.session[CALLBACK_STATE_KEY] = JSON.generate callback_state
         redirect_uri
       end
 
@@ -151,20 +154,22 @@ module Google
       #  Optional key-values to be returned to the oauth callback.
       # @return [String]
       #  Authorization url
+      # @raise [Google::Auth::InitializationError]
+      #  If request is nil or request.session is nil
       def get_authorization_url options = {}
         options = options.dup
         request = options[:request]
-        raise NIL_REQUEST_ERROR if request.nil?
-        raise NIL_SESSION_ERROR if request.session.nil?
+        raise InitializationError, NIL_REQUEST_ERROR if request.nil?
+        raise InitializationError, NIL_SESSION_ERROR if request.session.nil?
 
         state = options[:state] || {}
 
         redirect_to = options[:redirect_to] || request.url
         request.session[XSRF_KEY] = SecureRandom.base64
-        options[:state] = MultiJson.dump(state.merge(
-                                           SESSION_ID_KEY  => request.session[XSRF_KEY],
-                                           CURRENT_URI_KEY => redirect_to
-                                         ))
+        options[:state] = JSON.generate(state.merge(
+                                          SESSION_ID_KEY  => request.session[XSRF_KEY],
+                                          CURRENT_URI_KEY => redirect_to
+                                        ))
         options[:base_url] = request.url
         super options
       end
@@ -181,15 +186,15 @@ module Google
       #  requested scopes
       # @return [Google::Auth::UserRefreshCredentials]
       #  Stored credentials, nil if none present
-      # @raise [Signet::AuthorizationError]
-      #  May raise an error if an authorization code is present in the session
-      #  and exchange of the code fails
+      # @raise [Google::Auth::AuthorizationError]
+      #  If the authorization code is missing, there's an error in the request,
+      #  or the state token doesn't match
       def get_credentials user_id, request = nil, scope = nil
         if request&.session&.key? CALLBACK_STATE_KEY
           # Note - in theory, no need to check required scope as this is
           # expected to be called immediately after a return from authorization
           state_json = request.session.delete CALLBACK_STATE_KEY
-          callback_state = MultiJson.load state_json
+          callback_state = JSON.parse state_json
           WebUserAuthorizer.validate_callback_state callback_state, request
           get_and_store_credentials_from_code(
             user_id:  user_id,
@@ -202,8 +207,14 @@ module Google
         end
       end
 
+      # Extract the callback state from the request
+      #
+      # @param [Rack::Request] request
+      #  Current request
+      # @return [Array<Hash, String>]
+      #  Callback state and redirect URI
       def self.extract_callback_state request
-        state = MultiJson.load(request.params[STATE_PARAM] || "{}")
+        state = JSON.parse(request.params[STATE_PARAM] || "{}")
         redirect_uri = state[CURRENT_URI_KEY]
         callback_state = {
           AUTH_CODE_KEY  => request.params[AUTH_CODE_KEY],
@@ -214,6 +225,15 @@ module Google
         [callback_state, redirect_uri]
       end
 
+      # Returns the principal identifier for this web authorizer
+      # This is a class method that returns a symbol since
+      # we might not have a client_id in the static callback context
+      #
+      # @return [Symbol] The symbol for web user authorization
+      def self.principal
+        :web_user_authorization
+      end
+
       # Verifies the results of an authorization callback
       #
       # @param [Hash] state
@@ -224,13 +244,30 @@ module Google
       #  Error message if failed
       # @param [Rack::Request] request
       #  Current request
+      # @raise [Google::Auth::AuthorizationError]
+      #  If the authorization code is missing, there's an error in the callback state,
+      #  or the state token doesn't match
       def self.validate_callback_state state, request
-        raise Signet::AuthorizationError, MISSING_AUTH_CODE_ERROR if state[AUTH_CODE_KEY].nil?
+        if state[AUTH_CODE_KEY].nil?
+          raise AuthorizationError.with_details(
+            MISSING_AUTH_CODE_ERROR,
+            credential_type_name: name,
+            principal: principal
+          )
+        end
+
         if state[ERROR_CODE_KEY]
-          raise Signet::AuthorizationError,
-                format(AUTHORIZATION_ERROR, state[ERROR_CODE_KEY])
+          raise AuthorizationError.with_details(
+            format(AUTHORIZATION_ERROR, state[ERROR_CODE_KEY]),
+            credential_type_name: name,
+            principal: principal
+          )
         elsif request.session[XSRF_KEY] != state[SESSION_ID_KEY]
-          raise Signet::AuthorizationError, INVALID_STATE_TOKEN_ERROR
+          raise AuthorizationError.with_details(
+            INVALID_STATE_TOKEN_ERROR,
+            credential_type_name: name,
+            principal: principal
+          )
         end
       end
 

data/lib/googleauth.rb

@@ -18,6 +18,7 @@ require "googleauth/bearer_token"
 require "googleauth/client_id"
 require "googleauth/credentials"
 require "googleauth/default_credentials"
+require "googleauth/errors"
 require "googleauth/external_account"
 require "googleauth/id_tokens"
 require "googleauth/impersonated_service_account"