125 lines
4.7 KiB
Ruby
125 lines
4.7 KiB
Ruby
# Copyright 2015, Google Inc.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are
|
|
# met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above
|
|
# copyright notice, this list of conditions and the following disclaimer
|
|
# in the documentation and/or other materials provided with the
|
|
# distribution.
|
|
# * Neither the name of Google Inc. nor the names of its
|
|
# contributors may be used to endorse or promote products derived from
|
|
# this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
require 'multi_json'
|
|
require 'stringio'
|
|
|
|
require 'googleauth/credentials_loader'
|
|
require 'googleauth/compute_engine'
|
|
require 'googleauth/service_account'
|
|
require 'googleauth/user_refresh'
|
|
require 'googleauth/client_id'
|
|
require 'googleauth/user_authorizer'
|
|
|
|
module Google
|
|
# Module Auth provides classes that provide Google-specific authorization
|
|
# used to access Google APIs.
|
|
module Auth
|
|
NOT_FOUND_ERROR = <<END
|
|
Could not load the default credentials. Browse to
|
|
https://developers.google.com/accounts/docs/application-default-credentials
|
|
for more information
|
|
END
|
|
|
|
# DefaultCredentials is used to preload the credentials file, to determine
|
|
# which type of credentials should be loaded.
|
|
class DefaultCredentials
|
|
extend CredentialsLoader
|
|
|
|
# override CredentialsLoader#make_creds to use the class determined by
|
|
# loading the json.
|
|
def self.make_creds(options = {})
|
|
json_key_io, scope = options.values_at(:json_key_io, :scope)
|
|
if json_key_io
|
|
json_key, clz = determine_creds_class(json_key_io)
|
|
clz.make_creds(json_key_io: StringIO.new(MultiJson.dump(json_key)),
|
|
scope: scope)
|
|
else
|
|
clz = read_creds
|
|
clz.make_creds(scope: scope)
|
|
end
|
|
end
|
|
|
|
def self.read_creds
|
|
env_var = CredentialsLoader::ACCOUNT_TYPE_VAR
|
|
type = ENV[env_var]
|
|
fail "#{ACCOUNT_TYPE_VAR} is undefined in env" unless type
|
|
case type
|
|
when 'service_account'
|
|
ServiceAccountCredentials
|
|
when 'authorized_user'
|
|
UserRefreshCredentials
|
|
else
|
|
fail "credentials type '#{type}' is not supported"
|
|
end
|
|
end
|
|
|
|
# Reads the input json and determines which creds class to use.
|
|
def self.determine_creds_class(json_key_io)
|
|
json_key = MultiJson.load(json_key_io.read)
|
|
key = 'type'
|
|
fail "the json is missing the '#{key}' field" unless json_key.key?(key)
|
|
type = json_key[key]
|
|
case type
|
|
when 'service_account'
|
|
[json_key, ServiceAccountCredentials]
|
|
when 'authorized_user'
|
|
[json_key, UserRefreshCredentials]
|
|
else
|
|
fail "credentials type '#{type}' is not supported"
|
|
end
|
|
end
|
|
end
|
|
|
|
# Obtains the default credentials implementation to use in this
|
|
# environment.
|
|
#
|
|
# Use this to obtain the Application Default Credentials for accessing
|
|
# Google APIs. Application Default Credentials are described in detail
|
|
# at http://goo.gl/IUuyuX.
|
|
#
|
|
# If supplied, scope is used to create the credentials instance, when it can
|
|
# be applied. E.g, on google compute engine and for user credentials the
|
|
# scope is ignored.
|
|
#
|
|
# @param scope [string|array|nil] the scope(s) to access
|
|
# @param options [hash] allows override of the connection being used
|
|
def get_application_default(scope = nil, options = {})
|
|
creds = DefaultCredentials.from_env(scope) ||
|
|
DefaultCredentials.from_well_known_path(scope) ||
|
|
DefaultCredentials.from_system_default_path(scope)
|
|
return creds unless creds.nil?
|
|
fail NOT_FOUND_ERROR unless GCECredentials.on_gce?(options)
|
|
GCECredentials.new
|
|
end
|
|
|
|
module_function :get_application_default
|
|
end
|
|
end
|