awskeyring 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c691b2c94541dc7bf3562ae06b25231dbc8b04f42a04cb327209424f46c9849
-  data.tar.gz: a4c0362c4656c64de13708d44a38a1258da651abc1fb79635d99992b0259fd4a
+  metadata.gz: cf00f602f71d488e5786047871727580791f3805cf53055c9d720801bae6b75b
+  data.tar.gz: be06827683d764c13767a1cda773b81dd1bcfa5e4c09958119a1b8b63698ec9c
 SHA512:
-  metadata.gz: d7982836f83b748af2e4a64ce91b74f33f7f26a6423919fe0ce114011b8ffae9af61039e93a9307e7caeb97eb60ba22131dc57725d6bedd69529fc80e57c6db2
-  data.tar.gz: 79700754547b8ce87008a8624686dac7d362947f48e2e9a8a9904e71522454c53c63ed5edfc0fea5f16f5b2be9409641375836fb78fc0dd1c6f91c7b7b6464ca
+  metadata.gz: 1adf1d2f3a8e3791494fb473a91ccebf471390120cebcbb0d1372824407637077eec4dbab37fcd4036b7f88488ba0e12e185169723144db4f5dad9222ab354b0
+  data.tar.gz: 2d829ba0a4fd623b52364f9b4b1e7918240722da89062f23e14c21d797bf2a7f55943579c39ae09f42933515f0ea476dfe23e6090dd98de6669da34aeda4b329

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [v1.3.0](https://github.com/servian/awskeyring/tree/v1.3.0) (2020-02-20)
+
+[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)

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 group :development do
   gem 'github_changelog_generator'
   gem 'rake'
+  gem 'ronn'
   gem 'rspec'
   gem 'rubocop'
   gem 'rubocop-md'

data/README.md

@@ -87,7 +87,7 @@ To set your environment easily the following bash function helps:
 
 ## Development
 
-After checking out the repo, run `bundle update` to install dependencies. Then, run `rake` to run the tests. Run `bundle exec awskeyring` to use the gem in this directory, ignoring other installed copies of this gem. Awskeyring is tested against the last two versions of Ruby shipped with macOS.
+After checking out the repo, run `bundle update` to install dependencies. Then, run `bundle exec rake` to run the tests. Run `bundle exec awskeyring` to use the gem in this directory, ignoring other installed copies of this gem. Awskeyring is tested against the last two versions of Ruby shipped with macOS.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
@@ -99,6 +99,11 @@ If you believe you have found a security issue in Awskeyring, please responsibly
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/servian/awskeyring. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
 
+### 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).

data/Rakefile

@@ -35,9 +35,15 @@ task :filemode do
   print "\n"
 end
 
+desc 'generate manpage'
+task :ronn do
+  system('ronn -w -r man/awskeyring.5.ronn')
+  puts
+end
+
 YARD::Rake::YardocTask.new do |t|
   t.options = ['--fail-on-warning', '--no-progress']
   t.stats_options = ['--list-undoc']
 end
 
-task default: %i[filemode rubocop spec yard]
+task default: %i[filemode rubocop spec ronn yard]

data/lib/awskeyring/version.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 
+require 'json'
+
+# Awskeyring Module,
+# Version const and query of latest.
 module Awskeyring
   # The Gem's version number
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
   # The Gem's homepage
   HOMEPAGE = 'https://github.com/servian/awskeyring'
+
+  # RubyGems Version url
+  GEM_VERSION_URL = 'https://rubygems.org/api/v1/versions/awskeyring/latest.json'
+
+  # Retrieve the latest version from RubyGems
+  #
+  def self.latest_version
+    uri       = URI(GEM_VERSION_URL)
+    request   = Net::HTTP.new(uri.host, uri.port)
+    request.use_ssl = true
+    JSON.parse(request.get(uri).body)['version']
+  end
 end

data/lib/awskeyring_command.rb

@@ -34,9 +34,13 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   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
     puts "Awskeyring v#{Awskeyring::VERSION}"
+    if !options['no-remote'] && Awskeyring::VERSION != Awskeyring.latest_version
+      puts "the latest version v#{Awskeyring.latest_version}"
+    end
     puts "Homepage #{Awskeyring::HOMEPAGE}"
   end
 

data/man/awskeyring.5

@@ -0,0 +1,188 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AWSKEYRING" "5" "February 2020" "" ""
+.
+.SH "NAME"
+\fBAwskeyring\fR \- is a small tool to manage AWS account keys in the macOS Keychain\.
+.
+.SH "SYNOPSIS"
+awskeyring COMMAND [ACCOUNT|ROLE] [OPTIONS]
+.
+.P
+awskeyring help COMMAND
+.
+.SH "DESCRIPTION"
+The Awskeyring utility stores and manages AWS access keys and provides the facailty 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\.
+.
+.P
+The commands are as follows:
+.
+.TP
+\-\-version, \-v:
+.
+.IP
+Prints the version
+.
+.TP
+add ACCOUNT:
+.
+.IP
+Adds an ACCOUNT to the keyring
+.
+.TP
+add\-role ROLE:
+.
+.IP
+Adds a ROLE to the keyring
+.
+.TP
+console ACCOUNT:
+.
+.IP
+Open the AWS Console for the ACCOUNT
+.
+.TP
+env ACCOUNT:
+.
+.IP
+Outputs bourne shell environment exports for an ACCOUNT
+.
+.TP
+exec ACCOUNT command\.\.\.:
+.
+.IP
+Execute a COMMAND with the environment set for an ACCOUNT
+.
+.TP
+help [COMMAND]:
+.
+.IP
+Describe available commands or one specific command
+.
+.TP
+initialise:
+.
+.IP
+Initialises a new KEYCHAIN
+.
+.TP
+json ACCOUNT:
+.
+.IP
+Outputs AWS CLI compatible JSON for an ACCOUNT
+.
+.TP
+list:
+.
+.IP
+Prints a list of accounts in the keyring
+.
+.TP
+list\-role:
+.
+.IP
+Prints a list of roles in the keyring
+.
+.TP
+remove ACCOUNT:
+.
+.IP
+Removes an ACCOUNT from the keyring
+.
+.TP
+remove\-role ROLE:
+.
+.IP
+Removes a ROLE from the keyring
+.
+.TP
+remove\-token ACCOUNT:
+.
+.IP
+Removes a token for ACCOUNT from the keyring
+.
+.TP
+rotate ACCOUNT:
+.
+.IP
+Rotate access keys for an ACCOUNT
+.
+.TP
+token ACCOUNT [ROLE] [MFA]:
+.
+.IP
+Create an STS Token from a ROLE or an MFA code
+.
+.TP
+update ACCOUNT:
+.
+.IP
+Updates an ACCOUNT in the keyring
+.
+.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\.
+.
+.SH "EXIT STATUS"
+The Awskeyring utility exits 0 on success, and >0 if an error occurs\.
+.
+.SH "EXAMPLES"
+First you need to initialise your keychain to hold your AWS credentials\.
+.
+.IP "" 4
+.
+.nf
+
+awskeyring initialise
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Then add your keys to it\.
+.
+.IP "" 4
+.
+.nf
+
+awskeyring add personal\-aws
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Now your keys are stored safely in the macOS keychain\. To print environment variables run\.\.\.
+.
+.IP "" 4
+.
+.nf
+
+awskeyring env personal\-aws
+.
+.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\.
+.
+.SH "SECURITY"
+If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at \fItristan@vibrato\.com\.au\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\.
+.
+.SH "AUTHOR"
+Tristan Morgan \fItristan@vibrato\.com\.au\fR is the maintainer of Awskeyring\.
+.
+.SH "CONTRIBUTORS"
+.
+.IP "\(bu" 4
+Tristan tristanmorgan \fIhttps://github\.com/tristanmorgan\fR
+.
+.IP "\(bu" 4
+Adam Sir AzySir \fIhttps://github\.com/AzySir\fR
+.
+.IP "" 0
+.
+.SH "LICENSE"
+The gem is available as open source under the terms of the MIT License \fIhttps://opensource\.org/licenses/MIT\fR\.

data/man/awskeyring.5.ronn

@@ -0,0 +1,129 @@
+# 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 facailty 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
+
+*  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@vibrato.com.au](mailto:tristan@vibrato.com.au). 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@vibrato.com.au> 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).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awskeyring
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Tristan Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam
@@ -90,6 +90,8 @@ files:
 - lib/awskeyring/validate.rb
 - lib/awskeyring/version.rb
 - lib/awskeyring_command.rb
+- man/awskeyring.5
+- man/awskeyring.5.ronn
 homepage: https://github.com/servian/awskeyring
 licenses:
 - MIT