googleauth-extras 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a86b0a5307d997f90698df100b415f4a21d91b8a40f81758449ec3876b3eb86
+  data.tar.gz: 024a30daaed45790e9febd782300d197e5a9e0dd1494015912e07b34ceb081f5
+SHA512:
+  metadata.gz: d102b3fb295efc23afef1a4f945bff1a016e203fc25c73321ad3e4705854969a4fc8918bb37ac130b95c25804b8803a3ec86de468544bb797d67a41b90b7717c
+  data.tar.gz: c04a1a5fadc7e6cc4c8f378f479285de2c537b190cd08ee3685930d48d855edfb0dc993d69a35419329eef99ce69e36c724e50a7894a714668a4814c7380a9ad

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Max: 160
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ParameterLists:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 50
+
+RSpec/NamedSubject:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.7
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Release History
+
+0.1.0
+-----
+
+- Initial release with impersonated and static credential support.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in googleauth-extras.gemspec
+gemspec
+
+gem 'pry-byebug', '~> 3.10'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.45'
+gem 'rubocop-rspec', '~> 2.18'
+gem 'timecop', '~> 0.9.6'
+gem 'webmock', '~> 3.18'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Persona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# googleauth-extras
+
+**Disclaimer: This gem is not sponsored by Google.**
+
+The [googleauth](https://github.com/googleapis/google-auth-library-ruby) currently lacks support for all the authentication schemes supported in Python and the `gcloud` CLI. This gem aims to support additional schemes like:
+
+- Impersonated credentials
+- Static credentials
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'googleauth-extras'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install googleauth-extras
+
+## Usage
+
+### Impersonated Credentials
+
+If you'd like to have credentials that act as a different service account, you can setup the credentials with:
+
+```ruby
+Google::Apis::DriveV3::DriveService.new.tap do |ds|
+  ds.authorization = Google::Auth::Extras.impersonated_credential(
+    email_address: 'my-sa@my-project.iam.gserviceaccount.com',
+    scope: [
+      Google::Apis::SheetsV4::AUTH_DRIVE,
+    ],
+  )
+end
+```
+
+You can optionally specify the following additional options:
+
+- `base_credentials`: The credentials to use to make the impersonation call. If not specified, uses the standard SDK credential resolution process.
+- `delegate_email_addresses`: If there are intermediate service accounts that need to be impersonated using [delegation](https://cloud.google.com/iam/docs/create-short-lived-credentials-delegated#sa-credentials-permissions), the list of email addresses.
+- `lifetime`: The desired lifetime [in seconds](https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/generateAccessToken), defaulting to 1h.
+
+### Static Credentials
+
+If you'd like to use a static access token, you can setup the credentials with:
+
+```ruby
+# Old API Client
+Google::Apis::RequestOptions.default.authorization = Google::Auth::Extras.static_credential('my-access-token')
+# New API Client
+Google::Cloud.configure.credentials = Google::Auth::Extras.static_credential('my-access-token')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/persona-id/googleauth-extras.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'googleauth/extras'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/googleauth-extras.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/google/auth/extras/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'googleauth-extras'
+  spec.version       = Google::Auth::Extras::VERSION
+  spec.authors       = ['Persona Identities']
+  spec.email         = ['alex.coomans@withpersona.com']
+
+  spec.summary       = 'Additions to the googleauth gem for unsupported authentication schemes.'
+  spec.homepage      = 'https://github.com/persona-id/googleauth-extras'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['allowed_push_host']     = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/persona-id/googleauth-extras'
+  spec.metadata['changelog_uri']   = 'https://github.com/persona-id/googleauth-extras/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'addressable', '~> 2.8'
+  spec.add_runtime_dependency 'faraday', '>= 1.0', '< 3.0'
+  spec.add_runtime_dependency 'google-apis-iamcredentials_v1'
+  spec.add_runtime_dependency 'googleauth', '~> 1.3'
+  spec.add_runtime_dependency 'signet', '~> 0.17.0'
+end

data/lib/google/auth/extras/impersonated_credential.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Google
+  module Auth
+    module Extras
+      # This credential impersonates a service account.
+      class ImpersonatedCredential < Signet::OAuth2::Client
+        class MissingScope < StandardError; end
+
+        # A credential that impersonates a service account.
+        #
+        # @param base_credentials [Hash, String, Signet::OAuth2::Client]
+        #   Credentials to use to impersonate the provided email address.
+        #
+        # @param delegate_email_addresses [String, Array<String>]
+        #   The list of email address if there are intermediate service accounts that
+        #   need to be impersonated using delegation.
+        #
+        # @param email_address [String]
+        #   Email of the service account to impersonate.
+        #
+        # @param lifetime [String]
+        #   The desired lifetime (in seconds) of the token before needing to be refreshed.
+        #   Defaults to 1h, adjust as needed given a refresh is automatically performed
+        #   when the token less than 60s of remaining life and refresh requires an
+        #   additional API call.
+        #
+        # @param scope [String, Array<String>]
+        #   The OAuth 2 scopes to request. Can either be formatted as a comma seperated string or array.
+        #
+        # @see https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/generateAccessToken
+        # @see https://cloud.google.com/iam/docs/create-short-lived-credentials-delegated#sa-credentials-permissions
+        #
+        def initialize(email_address:, scope:, base_credentials: nil, delegate_email_addresses: nil, lifetime: nil)
+          super(scope: scope)
+
+          raise MissingScope if self.scope.nil? || self.scope.empty?
+
+          @iam_credentials_service = Google::Apis::IamcredentialsV1::IAMCredentialsService.new.tap do |ics|
+            ics.authorization = base_credentials if base_credentials
+          end
+
+          @impersonate_delegates = Array(delegate_email_addresses).map do |email|
+            transform_email_to_name(email)
+          end
+
+          @impersonate_lifetime = lifetime
+
+          @impersonate_name = transform_email_to_name(email_address)
+        end
+
+        def fetch_access_token(*)
+          access_token_request = Google::Apis::IamcredentialsV1::GenerateAccessTokenRequest.new(
+            scope: scope,
+          )
+
+          # The Google SDK doesn't like nil repeated values, but be careful with others as well.
+          access_token_request.delegates = @impersonate_delegates unless @impersonate_delegates.empty?
+          access_token_request.lifetime = @impersonate_lifetime unless @impersonate_lifetime.nil?
+
+          access_token_response = @iam_credentials_service.generate_service_account_access_token(@impersonate_name, access_token_request)
+
+          {
+            access_token: access_token_response.access_token,
+            expires_at: DateTime.rfc3339(access_token_response.expire_time).to_time,
+          }
+        end
+
+        private
+
+        def transform_email_to_name(email)
+          "projects/-/serviceAccounts/#{email}"
+        end
+      end
+    end
+  end
+end

data/lib/google/auth/extras/static_credential.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Google
+  module Auth
+    module Extras
+      # This credential uses a static access token.
+      class StaticCredential < Signet::OAuth2::Client
+        class AuthorizationExpired < StandardError; end
+
+        # A credential using a static access token.
+        #
+        # @param access_token [String]
+        #   The access token to use.
+        #
+        def initialize(access_token:)
+          super(
+            access_token: access_token,
+            expires_at: TokenInfo.lookup_access_token(access_token).fetch('exp'),
+            issued_at: nil,
+          )
+        end
+
+        def fetch_access_token(*)
+          raise RefreshNotSupported
+        rescue RefreshNotSupported
+          # This is a simple trick for getting the cause to be set.
+          raise Signet::AuthorizationError, 'Refresh not supported'
+        end
+      end
+    end
+  end
+end

data/lib/google/auth/extras/token_info.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Google
+  module Auth
+    module Extras
+      # This module provides methods to lookup details about authenication tokens,
+      # primarily for their expiration.
+      module TokenInfo
+        extend self
+
+        class LookupFailed < StandardError; end
+        class LookupMalformed < LookupFailed; end
+
+        TOKEN_INFO_URI = 'https://oauth2.googleapis.com/tokeninfo'
+        private_constant :TOKEN_INFO_URI
+
+        # Lookup the details for a valid access token, including it's expiration.
+        #
+        # @raise [LookupFailed]
+        #   If the token is invalid (including expired).
+        #
+        # @return [Hash]
+        #
+        # @see https://cloud.google.com/docs/authentication/token-types#access-contents
+        #
+        def lookup_access_token(token)
+          lookup(access_token: token)
+        end
+
+        private
+
+        def lookup(query)
+          url = Addressable::URI.parse(TOKEN_INFO_URI)
+          url.query_values = query
+
+          response = Faraday.default_connection.get(url.normalize.to_s)
+
+          raise LookupFailed, response.body.to_s unless response.status == 200
+
+          credentials = Signet::OAuth2.parse_credentials(response.body, response.headers['Content-Type'])
+
+          raise LookupMalformed, 'Missing token expiry' unless credentials['exp']
+
+          credentials['exp'] = parse_as_integer(credentials['exp'])
+          credentials['expires_in'] = parse_as_integer(credentials['expires_in'])
+
+          credentials.transform_values(&:freeze).freeze
+        end
+
+        def parse_as_integer(str)
+          return nil if str.nil?
+
+          str.to_i.tap do |value|
+            raise LookupMalformed unless value.to_s == str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/auth/extras/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Google
+  module Auth
+    module Extras
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/google/auth/extras.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'google/apis/iamcredentials_v1'
+require 'signet/oauth_2/client'
+
+require 'google/auth/extras/impersonated_credential'
+require 'google/auth/extras/static_credential'
+require 'google/auth/extras/token_info'
+require 'google/auth/extras/version'
+
+module Google
+  module Auth
+    # This module provides some extra features not supported in the normal googleauth gem.
+    module Extras
+      extend self
+
+      # Raised when a credential does not support refresh, like a static
+      # credential.
+      class RefreshNotSupported < StandardError; end
+
+      # A credential that impersonates a service account.
+      #
+      # @param base_credentials [Hash, String, Signet::OAuth2::Client]
+      #   Credentials to use to impersonate the provided email address.
+      #
+      # @param delegate_email_addresses [String, Array<String>]
+      #   The list of email address if there are intermediate service accounts that
+      #   need to be impersonated using delegation.
+      #
+      # @param email_address [String]
+      #   Email of the service account to impersonate.
+      #
+      # @param lifetime [String]
+      #   The desired lifetime (in seconds) of the token before needing to be refreshed.
+      #   Defaults to 1h, adjust as needed given a refresh is automatically performed
+      #   when the token less than 60s of remaining life and refresh requires an
+      #   additional API call.
+      #
+      # @param scope [String, Array<String>]
+      #   The OAuth 2 scopes to request. Can either be formatted as a comma seperated string or array.
+      #
+      # @return [Google::Auth::Extras::ImpersonatedCredential]
+      #
+      # @see https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/generateAccessToken
+      # @see https://cloud.google.com/iam/docs/create-short-lived-credentials-delegated#sa-credentials-permissions
+      #
+      def impersonated_credential(email_address:, scope:, base_credentials: nil, delegate_email_addresses: nil, lifetime: nil)
+        ImpersonatedCredential.new(
+          base_credentials: base_credentials,
+          delegate_email_addresses: delegate_email_addresses,
+          email_address: email_address,
+          lifetime: lifetime,
+          scope: scope,
+        )
+      end
+
+      # A credential using a static access token token.
+      #
+      # @param token [String]
+      #   The access token to use.
+      #
+      # @return [Google::Auth::Extras::StaticCredential]
+      #
+      def static_credential(token)
+        StaticCredential.new(access_token: token)
+      end
+    end
+  end
+end

data/lib/googleauth/extras.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# We use the proper path names, but match googleauth to make relation to upstream
+# gem more normal.
+require 'google/auth/extras'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: googleauth-extras
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Persona Identities
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: google-apis-iamcredentials_v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: signet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: 
+email:
+- alex.coomans@withpersona.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- googleauth-extras.gemspec
+- lib/google/auth/extras.rb
+- lib/google/auth/extras/impersonated_credential.rb
+- lib/google/auth/extras/static_credential.rb
+- lib/google/auth/extras/token_info.rb
+- lib/google/auth/extras/version.rb
+- lib/googleauth/extras.rb
+homepage: https://github.com/persona-id/googleauth-extras
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/persona-id/googleauth-extras
+  source_code_uri: https://github.com/persona-id/googleauth-extras
+  changelog_uri: https://github.com/persona-id/googleauth-extras/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Additions to the googleauth gem for unsupported authentication schemes.
+test_files: []