aws_cli_config_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3589f780327c218d9bc8bf20273c00ad3730999d1484083282eacb9eb3b94b
-  data.tar.gz: 49bab64edb2769d217642b212a5267e6b7c8b3a89502ebbcf1f4f7a9f2174dfb
+  metadata.gz: f8c25969c12735b879ffcc5a81a379394470e0d718c73ad9efd7a12762efeb76
+  data.tar.gz: d29b6630a7df7750a4052883d1c8f846273e3110a8419cc11b21a27bc78c195d
 SHA512:
-  metadata.gz: bb59817770089eb5c3ec25c6e31935af3f9ba6ca6b9b06b9075ad0eda4c9b9cb31a6713c7fc48bd57990b927b347c8c2fbb98746b4c41494fd3ad7a729c6ed6a
-  data.tar.gz: b1f0c10fa51f5697a589ee9428248e10b4a609e3aaffb41be9e268b2f1b07cb9bf3e25fd3efc6bdb0268a78a3e94f1610734261098eeb1914040d164fbece32f
+  metadata.gz: dcc6e615d2e26dcca17def0aacded8085fde1a7e76ee9cf771d088efcb58d09e342b83cf843e0696de3541b7175bbbce46a387ec88db45c8bfc4d7663ea6d87b
+  data.tar.gz: 5d51bcfe4c57079bb4722d3738413fb5c6bac52f6b0d19eead9e456d840e3477cc881ecaa682d1318df959e9e546fd26ca7802f8b06e110c94ba305d49545bd8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-05-26
+
+- Added a limited CLI frontend.
+
 ## [0.1.0] - 2021-05-08
 
 - First release: parses all files in the AWS CLI configuration folder and merges information.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aws_cli_config_parser (0.1.0)
+    aws_cli_config_parser (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,7 +10,7 @@ GEM
     rake (13.0.3)
 
 PLATFORMS
-  x86_64-linux-musl
+  x86_64-linux
 
 DEPENDENCIES
   aws_cli_config_parser!
@@ -18,4 +18,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.16
+   2.2.17

data/README.md

@@ -1,6 +1,6 @@
 # AWS CLI Configuration Parser
 
-This Ruby gem provides a tool to parse profile settings and secrets from AWS CLI configuration files, including the cached credentials from STS AssumeRole calls. This is often useful when using the AWS CLI with roles that require an MFA code. After authenticating successfully with an MFA code temporary session credentials are cached in your `~/.aws` folder. You'll often need to pass these temporary credentials to other tools such as Docker containers. This gem parses the files in your `~/.aws` folder and merges all information allowing you to retrieve any credential or setting.
+This Ruby gem provides a tool to parse profile settings and secrets from AWS CLI configuration files, including temporary credentials cached by the CLI when using IAM roles. This is often useful when using CLI profiles that assume roles requiring an MFA code. After authenticating successfully with an MFA code, temporary session credentials are cached in your `~/.aws` folder. You'll often need to pass these temporary credentials to other tools such as Docker containers. This gem parses the files in your `~/.aws` folder and merges all information allowing you to retrieve any credential or setting.
 
 ## Installation
 
@@ -47,7 +47,7 @@ region = eu-central-1
 **~/.aws/credentials**
 ```
 [default]
-aws_access_key_id = AKID1111000011110000
+aws_access_key_id = ASIA1111000011110000
 aws_secret_access_key = SECRET1111000011110000111100001111000011
 ```
 
@@ -55,7 +55,7 @@ aws_secret_access_key = SECRET1111000011110000111100001111000011
 ```
 {
   "Credentials": {
-    "AccessKeyId": "AKID2222000022220000",
+    "AccessKeyId": "ASIA2222000022220000",
     "SecretAccessKey": "SECRET2222000022220000222200002222000022",
     "SessionToken": "SESSIONTOKEN222200002222000022220000222200002222000022220000etc",
     "Expiration": "<some timestamp in the future>"
@@ -80,7 +80,7 @@ default = profiles.get('default')
 default.get('region')
 # => "eu-west-1"
 default.get('aws_access_key_id')
-# => "AKID1111000011110000"
+# => "ASIA1111000011110000"
 default.get('aws_secret_access_key')
 # => "SECRET1111000011110000111100001111000011"
 
@@ -92,7 +92,7 @@ admin.get('region')
 admin.get('role_arn')
 # => "arn:aws:iam::222200002222:role/SomeRole"
 admin.get('aws_access_key_id')
-# => "AKID2222000022220000"
+# => "ASIA2222000022220000"
 admin.get('aws_secret_access_key')
 # => "SECRET2222000022220000222200002222000022"
 admin.get('aws_session_token')
@@ -105,7 +105,7 @@ Or if you prefer using hashes:
 AwsCliConfigParser.parse.to_h == {
   'default' => {
     'region'                => 'eu-west-1',
-    'aws_access_key_id'     => 'AKID1111000011110000',
+    'aws_access_key_id'     => 'ASIA1111000011110000',
     'aws_secret_access_key' => 'SECRET1111000011110000111100001111000011'
   },
   'admin' => {
@@ -113,7 +113,7 @@ AwsCliConfigParser.parse.to_h == {
     'role_arn'              => 'arn:aws:iam::222200002222:role/SomeRole',
     'source_profile'        => 'default',
     'role_session_name'     => 'session_name',
-    'aws_access_key_id'     => 'AKID2222000022220000',
+    'aws_access_key_id'     => 'ASIA2222000022220000',
     'aws_secret_access_key' => 'SECRET2222000022220000222200002222000022',
     'aws_session_token'     => 'SESSIONTOKEN222200002222000022220000222200002222000022220000etc',
   }
@@ -128,6 +128,35 @@ AwsCliConfigParser.parse(aws_directory: '/somewhere/else/.my-aws-folder')
 # => ...
 ```
 
+### CLI frontend
+
+This gem includes a limited CLI frontend. You can obtain a configuration value like this:
+
+```sh
+aws_cli_config_parser --profile admin --key aws_access_key_id
+# ASIA2222000022220000
+aws_cli_config_parser -p admin -k aws_access_key_id
+# ASIA2222000022220000
+```
+
+You can optionally define a fallback value to be returned in case the specified profile does not exist or the configuration parameter is not defined:
+
+```sh
+aws_cli_config_parser --profile bogus --key aws_access_key_id --fallback OOOPS
+# OOOPS
+aws_cli_config_parser -p bogus -k aws_access_key_id -f OOOPS
+# OOOPS
+```
+
+You can also specify a custom directory where the command will look for your AWS CLI configuration files:
+
+```sh
+aws_cli_config_parser --profile someone --key aws_access_key_id --directory /somewhere/else/.my-aws-folder
+# ASIA................
+aws_cli_config_parser -p someone -k aws_access_key_id -d /somewhere/else/.my-aws-folder
+# ASIA................
+```
+
 
 ## License
 

data/aws_cli_config_parser.gemspec

@@ -3,22 +3,22 @@
 require_relative 'lib/aws_cli_config_parser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'aws_cli_config_parser'
-  spec.version       = AwsCliConfigParser::VERSION
-  spec.authors       = ['brunze']
-
-  spec.summary       = 'Parses profile settings from AWS CLI configuration files.'
-  spec.description   = <<~DESCRIPTION.strip
+  spec.name        = 'aws_cli_config_parser'
+  spec.version     = AwsCliConfigParser::VERSION
+  spec.authors     = ['brunze']
+  spec.homepage    = 'https://github.com/brunze/aws_cli_config_parser'
+  spec.license     = 'MIT'
+  spec.summary     = 'Parses profile settings from AWS CLI configuration files.'
+  spec.description = <<~DESCRIPTION.strip
     Parses profile settings and secrets from AWS CLI configuration files,
-    including the cached credentials from AssumeRole such as when using MFA.
+    including temporary credentials cached by the CLI when using roles.
   DESCRIPTION
-  spec.homepage      = 'https://github.com/brunze/aws_cli_config_parser'
-  spec.license       = 'MIT'
+
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['homepage_uri']    = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = 'https://github.com/brunze/aws_cli_config_parser/CHANGELOG.md'
+  spec.metadata['changelog_uri']   = spec.homepage + '/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.
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
   spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables   = ['aws_cli_config_parser']
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem

data/bin/aws_cli_config_parser

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'aws_cli_config_parser/cli'
+
+begin
+  AwsCliConfigParser::CLI.new.dispatch(ARGV)
+rescue => error
+  $stderr.puts(error.message)
+  exit 1
+end

data/lib/aws_cli_config_parser/cli.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'aws_cli_config_parser'
+
+class AwsCliConfigParser::CLI; end
+
+require 'aws_cli_config_parser/cli/arguments'
+require 'optparse'
+
+class AwsCliConfigParser::CLI
+
+  def dispatch argv
+    arguments = parse_arguments(argv).validated!
+    fallback  = arguments.fallback_value
+
+    profiles = AwsCliConfigParser.parse(
+      aws_directory: arguments.aws_directory || '~/.aws',
+    )
+
+    if (profile = profiles.get(arguments.profile_name)).nil? && fallback.nil?
+      $stderr.puts "could not find profile `#{arguments.profile_name}`"
+      exit 1
+    elsif (value = profile&.get(arguments.parameter_name)).nil? && fallback.nil?
+      $stderr.puts "could not find a value for the parameter `#{arguments.parameter_name}`"
+      exit 1
+    else
+      puts value || fallback
+      exit 0
+    end
+  end
+
+  private
+
+  def parse_arguments argv
+    Arguments.new.tap do |arguments|
+      OptionParser.new do |parser|
+        parser.banner = <<~BANNER
+          Extracts a configuration value from AWS CLI configuration files.
+
+            Usage: aws_cli_config_parser -p PROFILE -k KEY [-f FALLBACK] [-d AWS_DIRECTORY]
+
+        BANNER
+
+        parser.on('-p', '--profile=PROFILE', 'Profile from which to extract the configuration value.') do |profile|
+          arguments.profile_name = profile
+        end
+        parser.on('-k', '--key=KEY', 'Name of the configuration parameter to extract.') do |key|
+          arguments.parameter_name = key
+        end
+        parser.on('-f', '--fallback=VALUE', 'A default value to be returned in case a configuration value cannot be found.') do |value|
+          arguments.fallback_value = value
+        end
+        parser.on('-d', '--directory=PATH', 'Path to the AWS CLI configuration directory (default: `~/.aws`).') do |path|
+          arguments.aws_directory = path
+        end
+
+        parser.on_tail('-h', '--help', 'Prints this message.') do
+          puts parser.help
+          exit
+        end
+        parser.on_tail('-v', '--version', 'Prints the program version.') do
+          puts AwsCliConfigParser::VERSION
+          exit
+        end
+      end
+      .parse!(argv)
+    end
+  end
+
+end

data/lib/aws_cli_config_parser/cli/arguments.rb

@@ -0,0 +1,14 @@
+require 'aws_cli_config_parser/refined/strings'
+
+class AwsCliConfigParser::CLI::Arguments
+  using AwsCliConfigParser::Refined::Strings
+
+  attr_accessor :profile_name, :parameter_name, :aws_directory, :fallback_value
+
+  def validated!
+    raise TypeError, "profile name is required (use -p, --profile)" if profile_name.nil?   || profile_name.blank?
+    raise TypeError, "parameter name is required (use -k, --key)"   if parameter_name.nil? || parameter_name.blank?
+    self
+  end
+
+end

data/lib/aws_cli_config_parser/refined/strings.rb

@@ -0,0 +1,15 @@
+module AwsCliConfigParser
+  module Refined
+    BLANK_RE = /\A[[:space:]]*\z/
+
+    module Strings
+      refine String do
+
+        def blank?
+          AwsCliConfigParser::Refined::BLANK_RE === self
+        end
+
+      end
+    end
+  end
+end

data/lib/aws_cli_config_parser/version.rb

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

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: aws_cli_config_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - brunze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Parses profile settings and secrets from AWS CLI configuration files,
-  including the cached credentials from AssumeRole such as when using MFA.
+  including temporary credentials cached by the CLI when using roles.
 email: 
-executables: []
+executables:
+- aws_cli_config_parser
 extensions: []
 extra_rdoc_files: []
 files:
@@ -26,12 +27,16 @@ files:
 - README.md
 - Rakefile
 - aws_cli_config_parser.gemspec
+- bin/aws_cli_config_parser
 - bin/console
 - lib/aws_cli_config_parser.rb
 - lib/aws_cli_config_parser/cached_credential.rb
+- lib/aws_cli_config_parser/cli.rb
+- lib/aws_cli_config_parser/cli/arguments.rb
 - lib/aws_cli_config_parser/profile.rb
 - lib/aws_cli_config_parser/profiles.rb
 - lib/aws_cli_config_parser/refined/arrays.rb
+- lib/aws_cli_config_parser/refined/strings.rb
 - lib/aws_cli_config_parser/version.rb
 homepage: https://github.com/brunze/aws_cli_config_parser
 licenses: