awskeyring 1.6.0 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8bf8ca4f1b8acb13b25ac0c3a362afcf390e5e8e8d5f1e42b1c4c68748f0149
-  data.tar.gz: 3693e3e8d7a9fa30ab1430cea360cd32c85c98a22a9ae68a725f236c335afe2b
+  metadata.gz: 3ea94b3d72f37d363e05a9d5cbcb7833a4039368b4ebe8f32a0d24b29bdb0e7b
+  data.tar.gz: 358d4bab4128a8e0defa2a1736c4e05820f2ec11e58e4c0c4d29489da94d892e
 SHA512:
-  metadata.gz: 7c786f1bf73ccbe18f3c259824dfbc60bcbcf70e611916b70b8349fd9a40350f045b7e5b8e676e71bbf7bb0feadba76f54da28816cf18c32dd7a2d7acdc1d3e0
-  data.tar.gz: 5a03251d5b09208802a0790b2d52dcfa3a581394e3cd041e79cf69fa39fbd298ec8e76ae47b237342f360402d85ea5b6512f7eea89163157dcff5fd7bbd946a5
+  metadata.gz: 402911d7d34d2f496c245dab3629ed55da0c21d4bd821829258db7221b54aac69fdaee8871984aae308cbe25576e2e6de493b362c8ef22bfc75987e8b0129ec0
+  data.tar.gz: 8dd73f4b26dfcf6173b1d8e8b3db16747110cc49a2bc120df425c789ff7025a93959becb526467393bd33eb832febb66c5fb86f00b1d61eebcd7091b126fbde0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Tristan Morgan
+Copyright (c) 2017-2021 Tristan Morgan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,8 @@
 # Awskeyring
 
-![Awskeyring](https://raw.githubusercontent.com/servian/awskeyring/master/awskeyring-144.png)
+![Awskeyring](https://raw.githubusercontent.com/servian/awskeyring/main/awskeyring-144.png)
 
-* [![Build Status](https://travis-ci.org/servian/awskeyring.svg?branch=master)](https://travis-ci.org/servian/awskeyring)
+* [![Build Status](https://travis-ci.com/servian/awskeyring.svg?branch=main)](https://travis-ci.com/servian/awskeyring)
 * [![Gem Version](https://badge.fury.io/rb/awskeyring.svg)](https://badge.fury.io/rb/awskeyring)
 * [![license MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 * [![All Downloads](https://ruby-gem-downloads-badge.herokuapp.com/awskeyring?type=total)](https://rubygems.org/gems/awskeyring)
@@ -27,6 +27,10 @@ Install it with:
 
     $ gem install awskeyring --user-install
 
+or via [homebrew gem](https://github.com/sportngin/brew-gem):
+
+    $ brew gem install awskeyring
+
 ## Wiki
 
 Please see the [Wiki](https://github.com/servian/awskeyring/wiki) for full usage instructions and tips.
@@ -57,7 +61,7 @@ more details on this config option.
 
 The CLI is using [Thor](http://whatisthor.com) with help provided interactively.
 
-    Commands:
+    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
@@ -113,6 +117,7 @@ the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
 
 * Tristan [tristanmorgan](https://github.com/tristanmorgan)
 * Adam Sir [AzySir](https://github.com/AzySir)
+* Vito Giarrusso [thtliife](https://github.com/thtliife)
 
 ## License
 

data/Rakefile

@@ -59,4 +59,5 @@ YARD::Rake::YardocTask.new do |t|
   t.stats_options = ['--list-undoc']
 end
 
+desc 'Run Linting, Tests and Documetation tasks'
 task default: %i[filemode rubocop spec ronn yard]

data/awskeyring.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = Awskeyring::HOMEPAGE
   spec.licenses      = ['MIT']
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/|^\..*|^.*\.png}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/|^\..*|C.*\.md|.*\.ronn|.*\.png}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata = {
     'bug_tracker_uri' => "#{Awskeyring::HOMEPAGE}/issues",
-    'changelog_uri' => "#{Awskeyring::HOMEPAGE}/blob/master/CHANGELOG.md",
+    'changelog_uri' => "#{Awskeyring::HOMEPAGE}/blob/main/CHANGELOG.md",
     'documentation_uri' => "https://rubydoc.info/gems/#{spec.name}/#{Awskeyring::VERSION}",
     'source_code_uri' => "#{Awskeyring::HOMEPAGE}/tree/v#{Awskeyring::VERSION}",
     'wiki_uri' => "#{Awskeyring::HOMEPAGE}/wiki"

data/i18n/en.yml

@@ -1,41 +1,24 @@
 ---
 en:
-  __version:
-    desc: Prints the version
-  add:
-    desc: Adds an ACCOUNT to the keyring
-  add_role:
-    desc: Adds a ROLE to the keyring
-  awskeyring:
-    desc: Autocompletion for bourne shells
-  console:
-    desc: Open the AWS Console for the ACCOUNT
-  env:
-    desc: Outputs bourne shell environment exports for an ACCOUNT
-  exec:
-    desc: Execute a COMMAND with the environment set for an ACCOUNT
-  import:
-    desc: Import an ACCOUNT to the keyring from ~/.aws/credentials
-  initialise:
-    desc: Initialises a new KEYCHAIN
-  json:
-    desc: Outputs AWS CLI compatible JSON for an ACCOUNT
-  list:
-    desc: Prints a list of accounts in the keyring
-  list_role:
-    desc: Prints a list of roles in the keyring
-  remove:
-    desc: Removes an ACCOUNT from the keyring
-  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
-  update:
-    desc: Updates an ACCOUNT in the keyring
+  __version_desc: Prints the version
+  add_desc: Adds an ACCOUNT to the keyring
+  add_role_desc: Adds a ROLE to the keyring
+  awskeyring_desc: Autocompletion for bourne shells
+  console_desc: Open the AWS Console for the ACCOUNT
+  default_desc: Run default help or initialise if needed.
+  env_desc: Outputs bourne shell environment exports for an ACCOUNT
+  exec_desc: Execute a COMMAND with the environment set for an ACCOUNT
+  import_desc: Import an ACCOUNT to the keyring from ~/.aws/credentials
+  initialise_desc: Initialises a new KEYCHAIN
+  json_desc: Outputs AWS CLI compatible JSON for an ACCOUNT
+  list_desc: Prints a list of accounts in the keyring
+  list_role_desc: Prints a list of roles in the keyring
+  remove_desc: Removes an ACCOUNT from the keyring
+  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
+  update_desc: Updates an ACCOUNT in the keyring
   method_option:
     arn: 'AWS role arn.'
     code: 'Virtual mfa CODE.'
@@ -49,6 +32,7 @@ en:
     notoken: 'Do not use saved token.'
     noremote: 'Do not validate with remote api.'
     path: 'The service PATH to open.'
+    browser: 'Specify an alternative browser.'
     role: 'The ROLE to assume.'
     secret: 'AWS account secret.'
     unset: 'Unset environment variables.'

data/lib/awskeyring.rb

@@ -27,6 +27,8 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
   DEFAULT_KEY_AGE = 90
   # Default Console Paths
   DEFAULT_CONSOLE_LIST = %w[cloudformation ec2/v2 iam rds route53 s3 sns sqs vpc].freeze
+  # Default Browsers
+  DEFAULT_BROWSER_LIST = %w[Brave FireFox Opera Safari Vivaldi].freeze
 
   # Retrieve the preferences
   #
@@ -201,6 +203,11 @@ module Awskeyring # rubocop:disable Metrics/ModuleLength
     prefs.key?('console') ? prefs['console'] : DEFAULT_CONSOLE_LIST
   end
 
+  # Return a list of browserss
+  def self.list_browsers
+    prefs.key?('browser') ? prefs['browser'] : DEFAULT_BROWSER_LIST
+  end
+
   # Return Key age warning number
   def self.key_age
     prefs.key?('keyage') ? prefs['keyage'] : DEFAULT_KEY_AGE

data/lib/awskeyring/awsapi.rb

@@ -27,6 +27,7 @@ module Awskeyring
       AWS_ACCOUNT_NAME
       AWS_ACCESS_KEY_ID
       AWS_ACCESS_KEY
+      AWS_CREDENTIAL_EXPIRATION
       AWS_SECRET_ACCESS_KEY
       AWS_SECRET_KEY
       AWS_SECURITY_TOKEN
@@ -126,6 +127,8 @@ module Awskeyring
       env_var = {}
       env_var['AWS_DEFAULT_REGION'] = 'us-east-1' unless region
 
+      params[:expiration] = Time.at(params[:expiry]).iso8601 unless params[:expiry].nil?
+
       params.each_key do |param_name|
         AWS_ENV_VARS.each do |var_name|
           if var_name.include?(param_name.to_s.upcase) && !params[param_name].nil?
@@ -142,7 +145,7 @@ module Awskeyring
     # @param [String] key The aws_access_key_id
     # @param [String] secret The aws_secret_access_key
     # @param [String] token The aws_session_token
-    def self.verify_cred(key:, secret:, token:)
+    def self.verify_cred(key:, secret:, token: nil)
       begin
         ENV['AWS_DEFAULT_REGION'] = 'us-east-1' unless region
         sts = Aws::STS::Client.new(access_key_id: key, secret_access_key: secret, session_token: token)

data/lib/awskeyring/input.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'io/console'
-
 # Awskeyring Module,
 module Awskeyring
   # Input methods for Awskeyring
@@ -15,18 +13,20 @@ module Awskeyring
     end
 
     private_class_method def self.hide_input # rubocop:disable Metrics/MethodLength
+      require 'io/console'
       password = +''
       loop do
         character = $stdin.getch
         break unless character
 
-        if ["\n", "\r"].include? character
+        case character
+        when "\n", "\r"
           puts ''
           break
-        elsif ["\b", "\u007f"].include? character
+        when "\b", "\u007f"
           password.chop!
           print "\b\e[P"
-        elsif character == "\u0003"
+        when "\u0003"
           exit 1
         else
           print '*'

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.6.0'
+  VERSION = '1.8.3'
   # The Gem's homepage
   HOMEPAGE = 'https://github.com/servian/awskeyring'
 

data/lib/awskeyring_command.rb

@@ -11,29 +11,41 @@ require 'awskeyring/version'
 
 # AWSkeyring command line interface.
 class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
+  package_name 'Awskeyring'
   I18n.load_path = Dir.glob(File.join(File.realpath(__dir__), '..', 'i18n', '*.{yml,yaml}'))
   I18n.backend.load_translations
 
   map %w[--version -v] => :__version
   map %w[--help -h] => :help
-  map ['init'] => :initialise
-  map ['adr'] => :add_role
-  map ['con'] => :console
-  map ['ls'] => :list
-  map ['lsr'] => :list_role
-  map ['rm'] => :remove
-  map ['rmr'] => :remove_role
-  map ['rmt'] => :remove_token
-  map ['rot'] => :rotate
-  map ['tok'] => :token
-  map ['up'] => :update
+  map 'init' => :initialise
+  map 'adr' => :add_role
+  map 'con' => :console
+  map 'ls' => :list
+  map 'lsr' => :list_role
+  map 'rm' => :remove
+  map 'rmr' => :remove_role
+  map 'rmt' => :remove_token
+  map 'rot' => :rotate
+  map 'tok' => :token
+  map 'up' => :update
+  default_command :default
 
   # default to returning an error on failure.
   def self.exit_on_failure?
     true
   end
 
-  desc '--version, -v', I18n.t('__version.desc')
+  desc 'default', I18n.t('default_desc'), hide: true
+  # default command to run
+  def default
+    if Awskeyring.prefs.empty?
+      invoke :initialise
+    else
+      invoke :help
+    end
+  end
+
+  desc '--version, -v', I18n.t('__version_desc')
   method_option 'no-remote', type: :boolean, aliases: '-r', desc: I18n.t('method_option.noremote'), default: false
   # print the version number
   def __version
@@ -44,7 +56,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     puts "Homepage #{Awskeyring::HOMEPAGE}"
   end
 
-  desc 'initialise', I18n.t('initialise.desc')
+  desc 'initialise', I18n.t('initialise_desc')
   method_option :keychain, type: :string, aliases: '-n', desc: I18n.t('method_option.keychain')
   # initialise the keychain
   def initialise
@@ -69,7 +81,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     puts I18n.t('message.addkeychain', keychain: keychain, exec_name: exec_name)
   end
 
-  desc 'list', I18n.t('list.desc')
+  desc 'list', I18n.t('list_desc')
   # list the accounts
   def list
     if Awskeyring.list_account_names.empty?
@@ -80,7 +92,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   end
 
   map 'list-role' => :list_role
-  desc 'list-role', I18n.t('list_role.desc')
+  desc 'list-role', I18n.t('list_role_desc')
   method_option 'detail', type: :boolean, aliases: '-d', desc: I18n.t('method_option.detail'), default: false
   # List roles
   def list_role
@@ -88,19 +100,19 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
       warn I18n.t('message.missing_role', bin: File.basename($PROGRAM_NAME))
       exit 1
     end
-    if options['detail']
+    if options[:detail]
       puts Awskeyring.list_role_names_plus.join("\n")
     else
       puts Awskeyring.list_role_names.join("\n")
     end
   end
 
-  desc 'env ACCOUNT', I18n.t('env.desc')
+  desc 'env ACCOUNT', I18n.t('env_desc')
   method_option 'no-token', type: :boolean, aliases: '-n', desc: I18n.t('method_option.notoken'), default: false
   method_option 'unset', type: :boolean, aliases: '-u', desc: I18n.t('method_option.unset'), default: false
   # Print Env vars
   def env(account = nil)
-    if options['unset']
+    if options[:unset]
       put_env_string(account: nil, key: nil, secret: nil, token: nil)
     else
       account = ask_check(
@@ -113,7 +125,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     end
   end
 
-  desc 'json ACCOUNT', I18n.t('json.desc')
+  desc 'json ACCOUNT', I18n.t('json_desc')
   method_option 'no-token', type: :boolean, aliases: '-n', desc: I18n.t('method_option.notoken'), default: false
   # Print JSON for use with credential_process
   def json(account)
@@ -130,7 +142,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     )
   end
 
-  desc 'import ACCOUNT', I18n.t('import.desc')
+  desc 'import ACCOUNT', I18n.t('import_desc')
   method_option 'no-remote', type: :boolean, aliases: '-r', desc: I18n.t('method_option.noremote'), default: false
   # Import an Account
   def import(account = nil) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -166,7 +178,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     end
   end
 
-  desc 'exec ACCOUNT command...', I18n.t('exec.desc')
+  desc 'exec ACCOUNT command...', I18n.t('exec_desc')
   method_option 'no-token', type: :boolean, aliases: '-n', desc: I18n.t('method_option.notoken'), default: false
   method_option 'no-bundle', type: :boolean, aliases: '-b', desc: I18n.t('method_option.nobundle'), default: false
   # execute an external command with env set
@@ -188,7 +200,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     end
   end
 
-  desc 'add ACCOUNT', I18n.t('add.desc')
+  desc 'add ACCOUNT', I18n.t('add_desc')
   method_option :key, type: :string, aliases: '-k', desc: I18n.t('method_option.key')
   method_option :secret, type: :string, aliases: '-s', desc: I18n.t('method_option.secret')
   method_option :mfa, type: :string, aliases: '-m', desc: I18n.t('method_option.mfa')
@@ -209,7 +221,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
       existing: options[:mfa], message: I18n.t('message.mfa'),
       flags: 'optional', validator: Awskeyring::Validate.method(:mfa_arn)
     )
-    Awskeyring::Awsapi.verify_cred(key: key, secret: secret, token: nil) unless options['no-remote']
+    Awskeyring::Awsapi.verify_cred(key: key, secret: secret) unless options['no-remote']
     Awskeyring.add_account(
       account: account,
       key: key,
@@ -219,7 +231,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     puts I18n.t('message.addaccount', account: account)
   end
 
-  desc 'update ACCOUNT', I18n.t('update.desc')
+  desc 'update ACCOUNT', I18n.t('update_desc')
   method_option :key, type: :string, aliases: '-k', desc: I18n.t('method_option.key')
   method_option :secret, type: :string, aliases: '-s', desc: I18n.t('method_option.secret')
   method_option 'no-remote', type: :boolean, aliases: '-r', desc: I18n.t('method_option.noremote'), default: false
@@ -247,7 +259,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   end
 
   map 'add-role' => :add_role
-  desc 'add-role ROLE', I18n.t('add_role.desc')
+  desc 'add-role ROLE', I18n.t('add_role_desc')
   method_option :arn, type: :string, aliases: '-a', desc: I18n.t('method_option.arn')
   # Add a role
   def add_role(role = nil)
@@ -267,7 +279,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     puts I18n.t('message.addrole', role: role)
   end
 
-  desc 'remove ACCOUNT', I18n.t('remove.desc')
+  desc 'remove ACCOUNT', I18n.t('remove_desc')
   # Remove an account
   def remove(account = nil)
     account = ask_check(
@@ -277,7 +289,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     Awskeyring.delete_account(account: account, message: I18n.t('message.delaccount', account: account))
   end
 
-  desc 'remove-token ACCOUNT', I18n.t('remove_token.desc')
+  desc 'remove-token ACCOUNT', I18n.t('remove_token_desc')
   # remove a session token
   def remove_token(account = nil)
     account = ask_check(
@@ -288,7 +300,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   end
 
   map 'remove-role' => :remove_role
-  desc 'remove-role ROLE', I18n.t('remove_role.desc')
+  desc 'remove-role ROLE', I18n.t('remove_role_desc')
   # remove a role
   def remove_role(role = nil)
     role = ask_check(
@@ -298,7 +310,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     Awskeyring.delete_role(role_name: role, message: I18n.t('message.delrole', role: role))
   end
 
-  desc 'rotate ACCOUNT', I18n.t('rotate.desc')
+  desc 'rotate ACCOUNT', I18n.t('rotate_desc')
   # rotate Account keys
   def rotate(account = nil) # rubocop:disable Metrics/MethodLength
     account = ask_check(
@@ -330,7 +342,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] [MFA]', I18n.t('token_desc')
   method_option :role, type: :string, aliases: '-r', desc: I18n.t('method_option.role')
   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')
@@ -385,8 +397,9 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     puts I18n.t('message.addtoken', account: account, time: Time.at(new_creds[:expiry].to_i))
   end
 
-  desc 'console ACCOUNT', I18n.t('console.desc')
+  desc 'console ACCOUNT', I18n.t('console_desc')
   method_option :path, type: :string, aliases: '-p', desc: I18n.t('method_option.path')
+  method_option :browser, type: :string, aliases: '-b', desc: I18n.t('method_option.browser')
   method_option 'no-token', type: :boolean, aliases: '-n', desc: I18n.t('method_option.notoken'), default: false
   method_option 'no-open', type: :boolean, aliases: '-o', desc: I18n.t('method_option.noopen'), default: false
   # Open the AWS Console
@@ -417,14 +430,16 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     if options['no-open']
       puts login_url
     else
-      pid = Process.spawn("open \"#{login_url}\"")
+      spawn_cmd = options[:browser] ? "open -a \"#{options[:browser]}\" \"#{login_url}\"" : "open \"#{login_url}\""
+      pid = Process.spawn(spawn_cmd)
       Process.wait pid
     end
   end
 
-  desc 'awskeyring CURR PREV', I18n.t('awskeyring.desc'), hide: true
+  desc "#{File.basename($PROGRAM_NAME)} CURR PREV", I18n.t('awskeyring_desc'), hide: true
+  map File.basename($PROGRAM_NAME) => :autocomplete
   # autocomplete
-  def awskeyring(curr, prev)
+  def autocomplete(curr, prev)
     comp_line = ENV['COMP_LINE']
     unless comp_line
       exec_name = File.basename($PROGRAM_NAME)
@@ -460,9 +475,11 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
     when 'remove-role', '-r', 'rmr'
       comp_len = 2
     when '--path', '-p'
-      comp_len = 4
+      comp_len = 40
     when 'remove-token', 'rmt'
-      comp_len = 5
+      comp_len = 50
+    when '--browser', '-b'
+      comp_len = 60
     end
 
     [curr, comp_len, sub_cmd]
@@ -487,12 +504,14 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
       list = Awskeyring.list_account_names
     when 2
       list = Awskeyring.list_role_names
-    when 3
+    when 3..10
       list = list_arguments(command: sub_cmd)
-    when 4
+    when 40
       list = Awskeyring.list_console_path
-    when 5
+    when 50
       list = Awskeyring.list_token_names
+    when 60
+      list = Awskeyring.list_browsers
     else
       exit 1
     end
@@ -500,7 +519,8 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   end
 
   def list_commands
-    self.class.all_commands.keys.map { |elem| elem.tr('_', '-') }.reject! { |elem| elem == 'awskeyring' }
+    commands = self.class.all_commands.keys.map { |elem| elem.tr('_', '-') }
+    commands.reject! { |elem| %w[autocomplete default].include?(elem) }
   end
 
   def list_arguments(command:)

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" "June 2020" "" ""
+.TH "AWSKEYRING" "5" "April 2021" "" ""
 .
 .SH "NAME"
 \fBAwskeyring\fR \- is a small tool to manage AWS account keys in the macOS Keychain
@@ -24,36 +24,90 @@ The commands are as follows:
 .IP
 Prints the version
 .
+.br
+.
+.IP
+\-r, \-\-no\-remote: Do not validate with remote api\.
+.
 .TP
 add ACCOUNT:
 .
 .IP
 Adds an ACCOUNT to the keyring
 .
+.br
+.
+.IP
+\-k, \-\-key=KEY: AWS account key id\.
+.
+.br
+\-s, \-\-secret=SECRET: AWS account secret\.
+.
+.br
+\-m, \-\-mfa=MFA: AWS virtual mfa arn\.
+.
+.br
+\-r, \-\-no\-remote: Do not validate with remote api\.
+.
 .TP
 add\-role ROLE:
 .
 .IP
 Adds a ROLE to the keyring
 .
+.br
+.
+.IP
+\-a, \-\-arn=ARN: AWS role arn\.
+.
 .TP
-console ACCOUNT:
+awskeyring console ACCOUNT:
 .
 .IP
 Open the AWS Console for the ACCOUNT
 .
+.br
+.
+.IP
+\-p, \-\-path=PATH: The service PATH to open\.
+.
+.br
+\-b, \-\-browser=BROWSER: Specify an alternative browser\.
+.
+.br
+\-n, \-\-no\-token: Do not use saved token\.
+.
+.br
+\-o, \-\-no\-open: Do not open the url\.
+.
 .TP
 env ACCOUNT:
 .
 .IP
 Outputs bourne shell environment exports for an ACCOUNT
 .
+.br
+.
+.IP
+\-n, \-\-no\-token: Do not use saved token\.
+.
+.br
+\-u, \-\-unset, \-\-no\-unset: Unset environment variables\.
+.
 .TP
 exec ACCOUNT command\.\.\.:
 .
 .IP
 Execute a COMMAND with the environment set for an ACCOUNT
 .
+.br
+.
+.IP
+\-n, \-\-no\-token: Do not use saved token\.
+.
+.br
+\-b, \-\-no\-bundle: Unset Bundler environment variables\.
+.
 .TP
 help [COMMAND]:
 .
@@ -66,18 +120,33 @@ import:
 .IP
 Import an ACCOUNT to the keyring from ~/\.aws/credentials
 .
+.br
+.
+.IP
+\-r, \-\-no\-remote: Do not validate with remote api\.
+.
 .TP
 initialise:
 .
 .IP
 Initialises a new KEYCHAIN
 .
+.br
+.
+.IP
+\-n, \-\-keychain=KEYCHAIN: Name of KEYCHAIN to initialise\.
+.
 .TP
 json ACCOUNT:
 .
 .IP
 Outputs AWS CLI compatible JSON for an ACCOUNT
 .
+.br
+.
+.IP
+\-n, \-\-no\-token: Do not use saved token\.
+.
 .TP
 list:
 .
@@ -90,6 +159,11 @@ list\-role:
 .IP
 Prints a list of roles in the keyring
 .
+.br
+.
+.IP
+\-d, \-\-detail, \-\-no\-detail: Show more detail\.
+.
 .TP
 remove ACCOUNT:
 .
@@ -120,12 +194,34 @@ token ACCOUNT [ROLE] [MFA]:
 .IP
 Create an STS Token from a ROLE or an MFA code
 .
+.br
+.
+.IP
+\-r, \-\-role=ROLE: The ROLE to assume\.
+.
+.br
+\-c, \-\-code=CODE: Virtual mfa CODE\.
+.
+.br
+\-d, \-\-duration=DURATION: Session DURATION in seconds\.
+.
 .TP
 update ACCOUNT:
 .
 .IP
 Updates an ACCOUNT in the keyring
 .
+.br
+.
+.IP
+\-k, \-\-key=KEY: AWS account key id\.
+.
+.br
+\-s, \-\-secret=SECRET: AWS account secret\.
+.
+.br
+\-r, \-\-no\-remote: Do not validate with remote api\.
+.
 .SH "ENVIRONMENT"
 The AWS_DEFAULT_REGION environment variable will be used for AWS API calls where specified or fall back to us\-east\-1 when not\.
 .
@@ -171,8 +267,34 @@ awskeyring env personal\-aws
 .
 .IP "" 0
 .
+.P
+To open the AWS Console (web page) with your default browser simply run\.\.\.
+.
+.IP "" 4
+.
+.nf
+
+awskeyring console personal\-aws
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Autocomplete is enabled in your current shell with the following command\.\.\.
+.
+.IP "" 4
+.
+.nf
+
+complete \-C /usr/local/bin/awskeyring awskeyring
+.
+.fi
+.
+.IP "" 0
+.
 .SH "HISTORY"
-The motivation of this application is to provide a local secure store of AWS credentials using specifically in the macOS Keychain, to have them easily accessed from the Terminal, and to provide useful functions like assuming roles and opening the AWS Console from the cli\. For Enterprise environments there are better suited tools to use like HashiCorp Vault \fIhttps://vaultproject\.io/\fR\.
+The motivation of this application is to provide a local secure store of AWS credentials using specifically in the macOS Keychain, to have them easily accessed from the Terminal, and to provide useful functions like assuming roles and opening the AWS Console from the cli\. It then expanded to include autocomplete and a desire to have an almost complete test coverage to prevent regressions in its functionality\. For Enterprise environments there are better suited tools to use like HashiCorp Vault \fIhttps://vaultproject\.io/\fR\.
 .
 .SH "SECURITY"
 If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at \fItristan\.morgan@servian\.com\fR\. Awskeyring is a Ruby script and as such Ruby is whitelisted to access your "awskeyring" keychain\. Use a strong password and keep the unlock time short\.
@@ -188,6 +310,9 @@ Tristan tristanmorgan \fIhttps://github\.com/tristanmorgan\fR
 .IP "\(bu" 4
 Adam Sir AzySir \fIhttps://github\.com/AzySir\fR
 .
+.IP "\(bu" 4
+Vito Giarrusso thtliife \fIhttps://github\.com/thtliife\fR
+.
 .IP "" 0
 .
 .SH "LICENSE"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awskeyring
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.3
 platform: ruby
 authors:
 - Tristan Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam
@@ -73,14 +73,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- SECURITY.md
 - awskeyring.gemspec
 - exe/awskeyring
 - i18n/en.yml
@@ -91,15 +87,14 @@ files:
 - lib/awskeyring/version.rb
 - lib/awskeyring_command.rb
 - man/awskeyring.5
-- man/awskeyring.5.ronn
 homepage: https://github.com/servian/awskeyring
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/servian/awskeyring/issues
-  changelog_uri: https://github.com/servian/awskeyring/blob/master/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/awskeyring/1.6.0
-  source_code_uri: https://github.com/servian/awskeyring/tree/v1.6.0
+  changelog_uri: https://github.com/servian/awskeyring/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/awskeyring/1.8.3
+  source_code_uri: https://github.com/servian/awskeyring/tree/v1.8.3
   wiki_uri: https://github.com/servian/awskeyring/wiki
 post_install_message: 
 rdoc_options: []

data/CHANGELOG.md

@@ -1,131 +0,0 @@
-# Changelog
-
-## [v1.6.0](https://github.com/servian/awskeyring/tree/v1.6.0) (2020-08-11)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.5.0...v1.6.0)
-
-**Implemented enhancements:**
-
-- Warn about missing accounts/roles [\#69](https://github.com/servian/awskeyring/pull/69) ([tristanmorgan](https://github.com/tristanmorgan))
-- RuboCop and Spec update [\#68](https://github.com/servian/awskeyring/pull/68) ([tristanmorgan](https://github.com/tristanmorgan))
-- Add SimpleCov reports. [\#67](https://github.com/servian/awskeyring/pull/67) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.5.0](https://github.com/servian/awskeyring/tree/v1.5.0) (2020-07-08)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.4.0...v1.5.0)
-
-**Implemented enhancements:**
-
-- No-Bundle env changes for exec. [\#66](https://github.com/servian/awskeyring/pull/66) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.4.0](https://github.com/servian/awskeyring/tree/v1.4.0) (2020-06-19)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.3...v1.4.0)
-
-**Implemented enhancements:**
-
-- Import Keys and Tokens from shared credentials files. [\#65](https://github.com/servian/awskeyring/pull/65) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.3.3](https://github.com/servian/awskeyring/tree/v1.3.3) (2020-06-04)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.2...v1.3.3)
-
-**Implemented enhancements:**
-
-- Change email references from Vibrato to Servian [\#64](https://github.com/servian/awskeyring/pull/64) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.3.2](https://github.com/servian/awskeyring/tree/v1.3.2) (2020-04-27)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.1...v1.3.2)
-
-**Fixed bugs:**
-
-- Fix I18n message load when used as a library. [\#63](https://github.com/servian/awskeyring/pull/63) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.3.1](https://github.com/servian/awskeyring/tree/v1.3.1) (2020-03-19)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.0...v1.3.1)
-
-**Implemented enhancements:**
-
-- Markdown linting changes and removed Rubocop-MD. [\#61](https://github.com/servian/awskeyring/pull/61) ([tristanmorgan](https://github.com/tristanmorgan))
-- Removed some redundant code. [\#60](https://github.com/servian/awskeyring/pull/60) ([tristanmorgan](https://github.com/tristanmorgan))
-
-**Merged pull requests:**
-
-- Update Ronn code and PR template. [\#59](https://github.com/servian/awskeyring/pull/59) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.3.0](https://github.com/servian/awskeyring/tree/v1.3.0) (2020-02-19)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.2.0...v1.3.0)
-
-**Implemented enhancements:**
-
-- Add a man-page and tweak README. [\#58](https://github.com/servian/awskeyring/pull/58) ([tristanmorgan](https://github.com/tristanmorgan))
-- Enhanced version [\#57](https://github.com/servian/awskeyring/pull/57) ([AzySir](https://github.com/AzySir))
-
-## [v1.2.0](https://github.com/servian/awskeyring/tree/v1.2.0) (2020-01-20)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.1.2...v1.2.0)
-
-**Implemented enhancements:**
-
-- Check for existing account keys and role arns [\#56](https://github.com/servian/awskeyring/pull/56) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.1.2](https://github.com/servian/awskeyring/tree/v1.1.2) (2020-01-06)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.1.1...v1.1.2)
-
-**Fixed bugs:**
-
-- Deprecation warning for exit\_on\_failure [\#55](https://github.com/servian/awskeyring/pull/55) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.1.1](https://github.com/servian/awskeyring/tree/v1.1.1) (2019-11-27)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.1.0...v1.1.1)
-
-**Implemented enhancements:**
-
-- Add --detail flag for roles. [\#54](https://github.com/servian/awskeyring/pull/54) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.1.0](https://github.com/servian/awskeyring/tree/v1.1.0) (2019-11-06)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.0.2...v1.1.0)
-
-**Implemented enhancements:**
-
-- Add completion to input prompts [\#53](https://github.com/servian/awskeyring/pull/53) ([tristanmorgan](https://github.com/tristanmorgan))
-- Check for existing \(or not\) role names [\#52](https://github.com/servian/awskeyring/pull/52) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.0.2](https://github.com/servian/awskeyring/tree/v1.0.2) (2019-10-18)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.0.1...v1.0.2)
-
-**Implemented enhancements:**
-
-- Move to a new home, Servian. [\#51](https://github.com/servian/awskeyring/pull/51) ([tristanmorgan](https://github.com/tristanmorgan))
-- Use RuboCop-RSpec too and expect\(\) more. [\#48](https://github.com/servian/awskeyring/pull/48) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.0.1](https://github.com/servian/awskeyring/tree/v1.0.1) (2019-05-23)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v1.0.0...v1.0.1)
-
-**Implemented enhancements:**
-
-- auto-complete the --version [\#47](https://github.com/servian/awskeyring/pull/47) ([tristanmorgan](https://github.com/tristanmorgan))
-
-**Fixed bugs:**
-
-- Unfreeze secret strings. [\#46](https://github.com/servian/awskeyring/pull/46) ([tristanmorgan](https://github.com/tristanmorgan))
-
-## [v1.0.0](https://github.com/servian/awskeyring/tree/v1.0.0) (2019-05-19)
-
-[Full Changelog](https://github.com/servian/awskeyring/compare/v0.10.0...v1.0.0)
-
-**Implemented enhancements:**
-
-- More RuboCop changes and tweaked version string. [\#45](https://github.com/servian/awskeyring/pull/45) ([tristanmorgan](https://github.com/tristanmorgan))
-
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/CODE_OF_CONDUCT.md

@@ -1,73 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-education, socio-economic status, nationality, personal appearance, race,
-religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [tristan.morgan@servian.com](mailto:tristan.morgan@servian.com). All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
-
-[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -1,48 +0,0 @@
-# How to contribute
-
-Bug reports and pull requests from users are what keep this project working.
-
-## Basics
-
-1. Create an issue and describe your idea
-2. [Fork it](https://github.com/servian/awskeyring/fork)
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Publish the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
-
-## Checking your work
-
-You can run the test suite.
-
-You can run [RuboCop] to check code style.
-
-You can run [RSpec] to see if anything broke.
-
-You can run [YARD] to see of your code is documented.
-
-The default Rake task, runnable using `rake`.
-
-## Write documentation
-
-This project has documentation in a few places:
-
-### Introduction and usage
-
-A friendly `README.md` written for many audiences.
-
-### Examples and advanced usage
-
-The [wiki].
-
-### API documentation
-
-API documentation is written as [YARD] docblocks in the Ruby code.
-
-This is rendered as Web pages on [Rubydoc.info][awskeyring on Rubydoc.info].
-
-[wiki]: https://github.com/servian/awskeyring/wiki
-[YARD]: https://yardoc.org/
-[awskeyring on Rubydoc.info]: https://www.rubydoc.info/gems/awskeyring
-[RuboCop]: https://rubocop.readthedocs.io/en/latest/
-[Rspec]: https://rspec.info

data/SECURITY.md

@@ -1,4 +0,0 @@
-# Security Policy
-
-If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at
-[tristan.morgan@servian.com](mailto:tristan.morgan@servian.com).

data/man/awskeyring.5.ronn

@@ -1,138 +0,0 @@
-# Awskeyring -- is a small tool to manage AWS account keys in the macOS Keychain
-
-## SYNOPSIS
-
-awskeyring COMMAND [ACCOUNT|ROLE] [OPTIONS]
-
-awskeyring help COMMAND
-
-## DESCRIPTION
-
-The Awskeyring utility stores and manages AWS access keys and provides the facility to generate access tokens with
-combinations of assumed roles and multi-factor-authentication codes. It includes autocompletion features and multiple
-validation checks for input parsing. It also includes the ability for the AWS CLI to call it directly to provide authentication.
-
-The commands are as follows:
-
-* --version, -v:
-
-    Prints the version
-
-* add ACCOUNT:
-
-    Adds an ACCOUNT to the keyring
-
-* add-role ROLE:
-
-    Adds a ROLE to the keyring
-
-* console ACCOUNT:
-
-    Open the AWS Console for the ACCOUNT
-
-* env ACCOUNT:
-
-    Outputs bourne shell environment exports for an ACCOUNT
-
-* exec ACCOUNT command...:
-
-    Execute a COMMAND with the environment set for an ACCOUNT
-
-* help [COMMAND]:
-
-    Describe available commands or one specific command
-
-* import:
-
-    Import an ACCOUNT to the keyring from ~/.aws/credentials
-
-* initialise:
-
-    Initialises a new KEYCHAIN
-
-* json ACCOUNT:
-
-    Outputs AWS CLI compatible JSON for an ACCOUNT
-
-* list:
-
-    Prints a list of accounts in the keyring
-
-* list-role:
-
-    Prints a list of roles in the keyring
-
-* remove ACCOUNT:
-
-    Removes an ACCOUNT from the keyring
-
-* remove-role ROLE:
-
-    Removes a ROLE from the keyring
-
-* remove-token ACCOUNT:
-
-    Removes a token for ACCOUNT from the keyring
-
-* rotate ACCOUNT:
-
-    Rotate access keys for an ACCOUNT
-
-* token ACCOUNT [ROLE] [MFA]:
-
-    Create an STS Token from a ROLE or an MFA code
-
-* update ACCOUNT:
-
-    Updates an ACCOUNT in the keyring
-
-## ENVIRONMENT
-
-The AWS_DEFAULT_REGION environment variable will be used for AWS API calls where specified or fall back to us-east-1
-when not.
-
-## EXIT STATUS
-
-The Awskeyring utility exits 0 on success, and >0 if an error occurs.
-
-## EXAMPLES
-
-First you need to initialise your keychain to hold your AWS credentials.
-
-    awskeyring initialise
-
-Then add your keys to it.
-
-    awskeyring add personal-aws
-
-Now your keys are stored safely in the macOS keychain. To print environment variables run...
-
-    awskeyring env personal-aws
-
-## HISTORY
-
-The motivation of this application is to provide a local secure store of AWS
-credentials using specifically in the macOS Keychain, to have them easily accessed
-from the Terminal, and to provide useful functions like assuming roles and opening
-the AWS Console from the cli.
-For Enterprise environments there are better suited tools to use
-like [HashiCorp Vault](https://vaultproject.io/).
-
-## SECURITY
-
-If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at
-[tristan.morgan@servian.com](mailto:tristan.morgan@servian.com). Awskeyring is a Ruby script and as such Ruby is whitelisted to
-access your "awskeyring" keychain. Use a strong password and keep the unlock time short.
-
-## AUTHOR
-
-Tristan Morgan <tristan.morgan@servian.com> is the maintainer of Awskeyring.
-
-## CONTRIBUTORS
-
-* Tristan [tristanmorgan](https://github.com/tristanmorgan)
-* Adam Sir [AzySir](https://github.com/AzySir)
-
-## LICENSE
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).