gaargh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5be00f9025dc2da224ad903119e28ffe8ff2d2e6ed1817abeec4df7df9db3b89
+  data.tar.gz: 82688fb326f5c034221b4d986a01af2dd6779e67df7e45bea859bbc34575024b
+SHA512:
+  metadata.gz: b4d5be9570636aa6aa6991f82a09ec359790d43e2ec305cb95276fe349a9f48ec0ec99f98a319ca71f96f9d22ae03612878838e445f4c6b593cd2a2d5dc629df
+  data.tar.gz: e3711674b834fab31ba5d2c003cd4049d17cc9455d15226599e5049bb5ee640075282d72931101b0f349f85c38da87287a811bc0162ed41d66aaab9e51a1d03c

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+max_line_length = 300

data/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.16.1
+    hooks:
+      - id: gitleaks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    # - id: no-commit-to-branch
+    #   args: ['--branch', 'main']
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-json
+    - id: check-added-large-files
+    - id: detect-private-key
+    - id: check-executables-have-shebangs
+    - id: check-merge-conflict
+    - id: mixed-line-ending
+      args:
+        - "--fix=lf"
+    - id: pretty-format-json
+      args:
+        - "--autofix"
+        - "--indent=4"
+        - "--no-sort-keys"
+  - repo: https://github.com/mattlqx/pre-commit-ruby
+    rev: v1.3.5
+    hooks:
+    - id: rubocop

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: <%= RUBY_VERSION[/^\d+\.\d+/, 0] %>
+
+  # Disable all cops for now. Only notify on DeprecatedClassMethods
+  DisabledByDefault: true
+Layout/LineLength:
+  Max: 300
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+Style/StringLiterals:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-13
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 do-i-need-a-username
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mark Lynch
+
+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,85 @@
+# Gaargh
+
+gaargh is a **G**CP **A**lternative **A**uthentication **R**uby **G**em **H**elper and it's also the noise I make when working with GCP and ruby.
+
+This gem was created as a work around for the lack of support for account impersonation using Ruby with GCP.
+
+Ruby isn't one of the 4 language that support account impersonation on GCP as documented [here](https://cloud.google.com/docs/authentication/provide-credentials-adc#sa-impersonation).
+
+The is a github feature request https://github.com/googleapis/google-auth-library-ruby/issues/353 but there has been no update since Nov 16, 2021.
+
+This gem uses the work around discussed in https://github.com/googleapis/google-cloud-ruby/issues/17915 as a work around for dealing with account impersonation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+bundler:
+
+```ruby
+gem 'gaargh'
+```
+
+Or
+
+`gem install 'gaargh'`
+
+## Usage
+
+EXample usage with `Google::Cloud::Storage` client.
+
+```ruby
+require 'gaargh'
+require 'google/cloud/storage'
+impersonated_credentials_client = Gaargh.impersonate_service_account(service_account_email: 'my-service-account@my-project-id.iam.gserviceaccount.com')
+storage = Google::Cloud::Storage.new(credentials: impersonated_credentials_client, project_id: 'my-project-id')
+puts storage.buckets.map { |b| b.name}
+token_info = Gaargh.token_expiration_time(access_token: impersonated_credentials_client.access_token)
+pp token_info
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gaargh.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Creating a Gem
+
+### Create a Gem Skeleton
+
+```bash
+bundle gem json_ruby_logger \
+--mit \
+--linter=rubocop \
+--test=rspec \
+--ci=github \
+--no-coc
+```
+
+### Build the gem
+
+```bash
+  gem build json_ruby_logger.gemspec
+```
+
+### push the gem to rubygems.org
+
+```bash
+  gem push json_ruby_logger-0.1.0.gem
+```
+
+## Revoke/yank a gem
+
+```bash
+  gem yank json_ruby_logger -v 0.1.0
+```
+
+## Bump Gem Version
+
+```bash
+  gem install gem-release
+  gem bump patch --skip-ci --push
+```

data/Rakefile

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

data/gaargh.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/gaargh/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gaargh"
+  spec.version = Gaargh::VERSION
+  spec.authors = ["ml"]
+  # spec.email = ["redacted@redacted"]
+
+  spec.summary = "Helper module for impersonating service accounts on GCP."
+  spec.description = "GCP account impersonation helper."
+  spec.homepage = "https://github.com/do-i-need-a-username/gaargh"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "google-apis-iamcredentials_v1", "~> 0.17"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gaargh/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gaargh
+  VERSION = "0.1.0"
+end

data/lib/gaargh.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+require_relative "gaargh/version"
+require 'google/apis/iamcredentials_v1'
+require 'logger'
+
+module Gaargh
+  class Error < StandardError; end
+  class << self
+    attr_writer :logger
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  # Returns an impersonated credentials client to be used with the GCP clients
+  # impersonated_credentials_client  = Gaargh.impersonate_service_account(service_account_email: 'my-service-account@my-project-id.iam.gserviceaccount.com')
+  # e.g. storage = Google::Cloud::Storage.new(credentials: impersonated_credentials_client, project_id: 'your-storage-project-id')
+  #
+  # @param [String] service_account_email - the email of the service account to impersonate (e.g. 'my-service-account@my-project-id.iam.gserviceaccount.com')
+  # @param [String] lifetime - the lifetime of the access token in seconds (default: 3600s)
+  # @return [Signet::OAuth2::Client] client - the client to be used with GCP clients
+  def self.impersonate_service_account(service_account_email: '', lifetime: '3600s', scopes: ['https://www.googleapis.com/auth/cloud-platform'])
+    creds_service = Google::Apis::IamcredentialsV1::IAMCredentialsService.new
+
+    creds_service.authorization = Google::Auth.get_application_default(scopes)
+
+    generate_token_request = Google::Apis::IamcredentialsV1::GenerateAccessTokenRequest.new(
+        lifetime: lifetime,
+        scope: ['https://www.googleapis.com/auth/cloud-platform']
+    )
+
+    impersonated_account = creds_service.generate_service_account_access_token("projects/-/serviceAccounts/#{service_account_email}", generate_token_request)
+    client = Signet::OAuth2::Client.new
+    client.access_token = impersonated_account.access_token
+    return client
+  end
+
+  # Returns information about the access token provided e.g. expiration time, email address etc.
+  #
+  # @param [String] access_token - the access token to retrieve information about
+  # @return [Hash] token_info - a hash containing information about the access token, error informaiton if the request fails
+  def self.token_expiration_time(access_token:)
+    uri = URI.parse("https://oauth2.googleapis.com/tokeninfo?access_token=#{access_token}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    request = Net::HTTP::Get.new(uri.request_uri)
+
+    response = http.request(request)
+
+    if response.code == '200'
+      data = JSON.parse(response.body)
+      expiration_time = Time.at(data['exp'].to_i)
+      logger.info("Token expires at: #{expiration_time}")
+      pp data
+      token_info = {
+        token_data: data,
+        token_expiration_time: expiration_time
+      }
+      return token_info
+    else
+      error_hash = {
+        error: "Failed to retrieve token information",
+        response_code: response.code,
+        response_body: response.body
+      }
+      logger.info("Error retrieving token information: response.code: #{response.code}, response.body: #{response.body}")
+      return error_hash
+    end
+  end
+end

data/sig/gaargh.rbs

@@ -0,0 +1,4 @@
+module Gaargh
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: gaargh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ml
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-iamcredentials_v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: GCP account impersonation helper.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".pre-commit-config.yaml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- gaargh.gemspec
+- lib/gaargh.rb
+- lib/gaargh/version.rb
+- sig/gaargh.rbs
+homepage: https://github.com/do-i-need-a-username/gaargh
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/do-i-need-a-username/gaargh
+  source_code_uri: https://github.com/do-i-need-a-username/gaargh
+  changelog_uri: https://github.com/do-i-need-a-username/gaargh
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Helper module for impersonating service accounts on GCP.
+test_files: []