awskeyring 1.8.4 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6214486cc6877ca62ed23c40f01636f0f5bd726f7d7fdd9dd7f310ec87da84
-  data.tar.gz: fede3a531c42bab12951bb316e8f4c0f9c3d383f60121c4993359013422fb6b4
+  metadata.gz: df8b15491f307691db7f25727bdc12f5a90ba71b816e6b14b14a71bdbd53c594
+  data.tar.gz: af3cc61ea5c8c44025254b5fb9a90a087e67a2c556f7391006acc188ab5be214
 SHA512:
-  metadata.gz: f23bed2643e3ab8f288ff690f20f540b8486a9aca792ff362696bf867009d36d874391f13b936cc1808a9908f1f16617d2fe81073e08c6620f0997835e653cb3
-  data.tar.gz: a9732e12755c7465545bdcd59a982f446a33e42988de10158a4db977c4d8fc5a8a391d6c55c67b835fb6af749dd3e77dfef1d335b04fa6683a6df1ce0a36d227
+  metadata.gz: c20ade29e6499e0fa836cb7532dd1dd8776659ed7c3e69cc905c6ea34ae5a46b3af24320a94781996af7cdbb0cc4e69fabe86259d7aaa99048b577c5a9a09208
+  data.tar.gz: 547a0ad97e0e38b7b6e61d7b8275ab75c18a114d83a540de293c410cd4835f4a429bf829863e62fce4c8350ece488d0d4d4a0571c17b9e1a0b97b4416eaa51e2

data/README.md

@@ -62,24 +62,24 @@ more details on this config option.
 The CLI is using [Thor](http://whatisthor.com) with help provided interactively.
 
     Awskeyring commands:
-      awskeyring --version, -v               # Prints the version
-      awskeyring add ACCOUNT                 # Adds an ACCOUNT to the keyring
-      awskeyring add-role ROLE               # Adds a ROLE to the keyring
-      awskeyring console ACCOUNT             # Open the AWS Console for the ACCOUNT
-      awskeyring env ACCOUNT                 # Outputs bourne shell environment exports for an ACCOUNT
-      awskeyring exec ACCOUNT command...     # Execute a COMMAND with the environment set for an ACCOUNT
-      awskeyring help [COMMAND]              # Describe available commands or one specific command
-      awskeyring import ACCOUNT              # Import an ACCOUNT to the keyring from ~/.aws/credentials
-      awskeyring initialise                  # Initialises a new KEYCHAIN
-      awskeyring json ACCOUNT                # Outputs AWS CLI compatible JSON for an ACCOUNT
-      awskeyring list                        # Prints a list of accounts in the keyring
-      awskeyring list-role                   # Prints a list of roles in the keyring
-      awskeyring remove ACCOUNT              # Removes an ACCOUNT from the keyring
-      awskeyring remove-role ROLE            # Removes a ROLE from the keyring
-      awskeyring remove-token ACCOUNT        # Removes a token for ACCOUNT from the keyring
-      awskeyring rotate ACCOUNT              # Rotate access keys for an ACCOUNT
-      awskeyring token ACCOUNT [ROLE] [MFA]  # Create an STS Token from a ROLE or an MFA code
-      awskeyring update ACCOUNT              # Updates an ACCOUNT in the keyring
+      awskeyring --version, -v                # Prints the version
+      awskeyring add ACCOUNT                  # Adds an ACCOUNT to the keyring
+      awskeyring add-role ROLE                # Adds a ROLE to the keyring
+      awskeyring console ACCOUNT              # Open the AWS Console for the ACCOUNT
+      awskeyring env ACCOUNT                  # Outputs bourne shell environment exports for an ACCOUNT
+      awskeyring exec ACCOUNT command...      # Execute a COMMAND with the environment set for an ACCOUNT
+      awskeyring help [COMMAND]               # Describe available commands or one specific command
+      awskeyring import ACCOUNT               # Import an ACCOUNT to the keyring from ~/.aws/credentials
+      awskeyring initialise                   # Initialises a new KEYCHAIN
+      awskeyring json ACCOUNT                 # Outputs AWS CLI compatible JSON for an ACCOUNT
+      awskeyring list                         # Prints a list of accounts in the keyring
+      awskeyring list-role                    # Prints a list of roles in the keyring
+      awskeyring remove ACCOUNT               # Removes an ACCOUNT from the keyring
+      awskeyring remove-role ROLE             # Removes a ROLE from the keyring
+      awskeyring remove-token ACCOUNT         # Removes a token for ACCOUNT from the keyring
+      awskeyring rotate ACCOUNT               # Rotate access keys for an ACCOUNT
+      awskeyring token ACCOUNT [ROLE] [CODE]  # Create an STS Token from a ROLE or an mfa CODE
+      awskeyring update ACCOUNT               # Updates an ACCOUNT in the keyring
 
 and autocomplete that can be installed with:
 

data/i18n/en.yml

@@ -17,7 +17,7 @@ en:
   remove_role_desc: Removes a ROLE from the keyring
   remove_token_desc: Removes a token for ACCOUNT from the keyring
   rotate_desc: Rotate access keys for an ACCOUNT
-  token_desc: Create an STS Token from a ROLE or an MFA code
+  token_desc: Create an STS Token from a ROLE or an mfa CODE
   update_desc: Updates an ACCOUNT in the keyring
   method_option:
     arn: 'AWS role arn.'

data/lib/awskeyring/version.rb

@@ -6,7 +6,7 @@ require 'json'
 # Version const and query of latest.
 module Awskeyring
   # The Gem's version number
-  VERSION = '1.8.4'
+  VERSION = '1.8.5'
   # The Gem's homepage
   HOMEPAGE = 'https://github.com/servian/awskeyring'
 

data/lib/awskeyring_command.rb

@@ -335,7 +335,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     puts I18n.t('message.upaccount', account: account)
   end
 
-  desc 'token ACCOUNT [ROLE] [MFA]', I18n.t('token_desc')
+  desc 'token ACCOUNT [ROLE] [CODE]', I18n.t('token_desc')
   method_option :code, type: :string, aliases: '-c', desc: I18n.t('method_option.code')
   method_option :duration, type: :string, aliases: '-d', desc: I18n.t('method_option.duration')
   # generate a sessiopn token
@@ -430,7 +430,8 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   desc "#{File.basename($PROGRAM_NAME)} CURR PREV", I18n.t('awskeyring_desc'), hide: true
   map File.basename($PROGRAM_NAME) => :autocomplete
   # autocomplete
-  def autocomplete(curr, prev)
+  def autocomplete(curr, prev = nil)
+    curr, prev = fix_args(curr, prev)
     comp_line = ENV['COMP_LINE']
     comp_point_str = ENV['COMP_POINT']
     unless comp_line && comp_point_str
@@ -448,16 +449,16 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
 
   private
 
-  def age_check_and_get(account:, no_token:)
-    cred = Awskeyring.get_valid_creds(account: account, no_token: no_token)
-
-    maxage = Awskeyring.key_age
-    age = (Time.new - cred[:updated]).div Awskeyring::Awsapi::ONE_DAY
-    warn I18n.t('message.age_check', account: account, age: age) unless age < maxage
-
-    cred
+  # when a double dash is parsed it is dropped from the args but we need it
+  def fix_args(curr, prev)
+    if prev.nil?
+      [ARGV[1], ARGV[2]]
+    else
+      [curr, prev]
+    end
   end
 
+  # determine the type of completion needed
   def comp_type(comp_lines:, prev:)
     sub_cmd = sub_command(comp_lines)
     comp_idx = comp_lines.rindex(prev)
@@ -475,8 +476,10 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     [comp_type, sub_cmd]
   end
 
+  # check params for named params or fall back to flags
   def param_type(comp_idx, sub_cmd)
-    param_list = method(sub_cmd).parameters
+    types = %i[opt req]
+    param_list = method(sub_cmd).parameters.select { |elem| types.include? elem[0] }
     if comp_idx.zero?
       :command
     elsif comp_idx > param_list.length
@@ -486,6 +489,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     end
   end
 
+  # catch the command from prefixes and aliases
   def sub_command(comp_lines)
     return '' if comp_lines.nil? || comp_lines.length < 2
 
@@ -498,6 +502,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     self.class.map[sub_cmd].to_s
   end
 
+  # given a type return the right list for completions
   def fetch_auto_resp(comp_type, sub_cmd)
     case comp_type
     when :command
@@ -517,11 +522,13 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     end
   end
 
+  # list command names
   def list_commands
     commands = self.class.all_commands.keys.map { |elem| elem.tr('_', '-') }
     commands.reject! { |elem| %w[autocomplete default].include?(elem) }
   end
 
+  # list flags for a command
   def list_arguments(command:)
     options = self.class.all_commands[command].options.values
     exit 1 if options.empty?
@@ -530,18 +537,32 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
       options.map(&:switch_name)
   end
 
+  # add warning about old keys
+  def age_check_and_get(account:, no_token:)
+    cred = Awskeyring.get_valid_creds(account: account, no_token: no_token)
+
+    maxage = Awskeyring.key_age
+    age = (Time.new - cred[:updated]).div Awskeyring::Awsapi::ONE_DAY
+    warn I18n.t('message.age_check', account: account, age: age) unless age < maxage
+
+    cred
+  end
+
+  # print exports from map
   def put_env_string(cred)
     env_var = Awskeyring::Awsapi.get_env_array(cred)
     env_var.each { |var, value| puts "export #{var}=\"#{value}\"" }
     Awskeyring::Awsapi::AWS_ENV_VARS.each { |key| puts "unset #{key}" unless env_var.key?(key) }
   end
 
+  # select duration for sts token types
   def default_duration(duration, role, code)
     duration ||= Awskeyring::Awsapi::ONE_HOUR.to_s if role
     duration ||= Awskeyring::Awsapi::TWELVE_HOUR.to_s if code
     duration || Awskeyring::Awsapi::ONE_HOUR.to_s
   end
 
+  # ask and validate input values.
   def ask_check(existing:, message:, flags: nil, validator: nil, limited_to: nil) # rubocop:disable Metrics/MethodLength
     retries ||= 3
     begin
@@ -562,10 +583,12 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     value
   end
 
+  # ask for somthinng if its missing.
   def ask_missing(existing:, message:, secure: false, optional: false, limited_to: nil)
     existing || ask(message: message, secure: secure, optional: optional, limited_to: limited_to).strip
   end
 
+  # ask in different ways
   def ask(message:, secure: false, optional: false, limited_to: nil)
     if secure
       Awskeyring::Input.read_secret("#{message.rjust(20)}: ")
@@ -578,6 +601,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     end
   end
 
+  # undo Bundler env vars
   def unbundle
     to_delete = ENV.keys.select { |elem| elem.start_with?('BUNDLER_ORIG_') }
     bundled_env = to_delete.map { |elem| elem[('BUNDLER_ORIG_'.length)..] }

data/man/awskeyring.5

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "AWSKEYRING" "5" "May 2021" "" ""
+.TH "AWSKEYRING" "5" "June 2021" "" ""
 .
 .SH "NAME"
 \fBAwskeyring\fR \- is a small tool to manage AWS account keys in the macOS Keychain
@@ -189,10 +189,10 @@ rotate ACCOUNT:
 Rotate access keys for an ACCOUNT
 .
 .TP
-token ACCOUNT [ROLE] [MFA]:
+token ACCOUNT [ROLE] [CODE]:
 .
 .IP
-Create an STS Token from a ROLE or an MFA code
+Create an STS Token from a ROLE or an mfa CODE
 .
 .br
 .

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awskeyring
 version: !ruby/object:Gem::Version
-  version: 1.8.4
+  version: 1.8.5
 platform: ruby
 authors:
 - Tristan Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam
@@ -93,8 +93,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/servian/awskeyring/issues
   changelog_uri: https://github.com/servian/awskeyring/blob/main/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/awskeyring/1.8.4
-  source_code_uri: https://github.com/servian/awskeyring/tree/v1.8.4
+  documentation_uri: https://rubydoc.info/gems/awskeyring/1.8.5
+  source_code_uri: https://github.com/servian/awskeyring/tree/v1.8.5
   wiki_uri: https://github.com/servian/awskeyring/wiki
 post_install_message: 
 rdoc_options: []