awskeyring 1.12.1 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155240a1418a0de58a8d3bd88fe97d607cb5f68ea6655f4b3e82ad6628683dad
-  data.tar.gz: 99224076df4e631f41e7aef1f0b8a713ff458887943303dbfd691af4e5ddd875
+  metadata.gz: daacd162f1bb61f73cfb0a40d13fbf64bbf4c29ff2a5fd64b93a198d7b480aac
+  data.tar.gz: ed615d2f74f0e2962b320dd8ca0616dc72b8190e2bdefbc29789bb90ab5f7322
 SHA512:
-  metadata.gz: c8cfc74bf58e2886e28c3ab58f3d04955a57dbbcc4bffe9f450a472651df70f2ab3e1585dc21b1118a1f14e5ae8a1703076f56ff5215f19d623c3420c1883b65
-  data.tar.gz: 6c0c9f2f7b5916067b016bac45a3088d349298aff18e6b90e554e7ce2791476d8a5865800e0bbe334d2b07146f8a14b6cd68312a82af43ad6aedc5ffde585106
+  metadata.gz: 2ed0290739e4ca068b2233fe25d5e62312cde392d2d592ddad88f979de6a078910c6abda59a40f1d4ef56b8a4fee295775dd0c5cb705d918b5c6dffbaa0c1d1f
+  data.tar.gz: 901e34269af131cb4f85d2811953acc6cae3cb529fb04b49880f372ad4e7547cab342b07c514bf820f19a6b91c5afcc6f5eb3b9e41ca182aed56f991224a36c6

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2022 Tristan Morgan
+Copyright (c) 2016-2025 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

@@ -12,6 +12,11 @@
 Awskeyring is a small tool to manage AWS account keys in the macOS Keychain. It has
 grown to incorporate a lot of [features](https://github.com/tristanmorgan/awskeyring/wiki/Awskeyring-features).
 
+## Project Status
+
+Awskeyring is a fairly mature project so it it doesn't see frequent updates but is still being maintained.
+It is tested against the version of Ruby that is shipped with the latest version of macOS, but that ruby version is dated.
+
 ## Motivation
 
 The motivation of this application is to provide a local secure store of AWS
@@ -79,6 +84,7 @@ The CLI is using [Thor](http://whatisthor.com) with help provided interactively.
       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 tree                         # Print a tree of all available commands
       awskeyring update ACCOUNT               # Updates an ACCOUNT in the keyring
 
 and autocomplete that can be installed with:

data/i18n/en.yml

@@ -33,6 +33,7 @@ en:
     notoken: 'Do not use saved token.'
     noremote: 'Do not validate with remote api.'
     path: 'The service PATH to open.'
+    test: 'Generate test credentials.'
     browser: 'Specify an alternative browser.'
     secret: 'AWS account secret.'
     unset: 'Unset environment variables.'

data/lib/awskeyring/awsapi.rb

@@ -3,6 +3,9 @@
 require 'aws-sdk-iam'
 require 'cgi'
 require 'json'
+require 'securerandom'
+
+require 'awskeyring/validate'
 
 # Awskeyring Module,
 # gives you an interface to access keychains and items.
@@ -91,8 +94,8 @@ module Awskeyring
       end
 
       {
-        key: response.credentials[:access_key_id],
-        secret: response.credentials[:secret_access_key],
+        key: Awskeyring::Validate.session_key(response.credentials[:access_key_id]),
+        secret: Awskeyring::Validate.secret_access_key(response.credentials[:secret_access_key]),
         token: response.credentials[:session_token],
         expiry: response.credentials[:expiration]
       }
@@ -180,6 +183,23 @@ module Awskeyring
       }
     end
 
+    # Generate test credentials for AWS
+    #
+    # @return [Hash] with the new credentials
+    #    key The aws_access_key_id
+    #    secret The aws_secret_access_key
+    #    expiry expiry time
+    def self.gen_test_credentials(account:)
+      {
+        account: account,
+        key: "AKIA#{Array.new(16) { [*'A'..'Z', *'2'..'7'].sample }.join}",
+        secret: SecureRandom.base64(30),
+        token: nil,
+        expiry: nil,
+        role: nil
+      }
+    end
+
     # Retrieves an AWS Console login url
     #
     # @param [String] key The aws_access_key_id

data/lib/awskeyring/validate.rb

@@ -25,6 +25,15 @@ module Awskeyring
       aws_access_key
     end
 
+    # Validate an AWS Session Key ID
+    #
+    # @param [String] aws_session_key The aws_session_key_id
+    def self.session_key(aws_session_key)
+      raise 'Invalid Session Key' unless /\AASIA[A-Z234567]{16}\z/.match?(aws_session_key)
+
+      aws_session_key
+    end
+
     # Validate an AWS Secret Key ID
     #
     # @param [String] aws_secret_access_key The aws_secret_access_key

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

data/lib/awskeyring_command.rb

@@ -109,10 +109,15 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   desc 'env ACCOUNT', I18n.t('env_desc')
   method_option :force, type: :boolean, aliases: '-f', desc: I18n.t('method_option.force'), default: false
   method_option 'no-token', type: :boolean, aliases: '-n', desc: I18n.t('method_option.notoken'), default: false
+  method_option :test, type: :boolean, aliases: '-t', desc: I18n.t('method_option.test'), 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[:test]
+      account ||= 'fakeaccount'
+      cred = Awskeyring::Awsapi.gen_test_credentials(account: account)
+      put_env_string(cred)
+    elsif options[:unset]
       put_env_string(account: nil, key: nil, secret: nil, token: nil)
     else
       output_safe(options[:force])
@@ -129,21 +134,32 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
   desc 'json ACCOUNT', I18n.t('json_desc')
   method_option :force, type: :boolean, aliases: '-f', desc: I18n.t('method_option.force'), default: false
   method_option 'no-token', type: :boolean, aliases: '-n', desc: I18n.t('method_option.notoken'), default: false
+  method_option :test, type: :boolean, aliases: '-t', desc: I18n.t('method_option.test'), default: false
   # Print JSON for use with credential_process
-  def json(account) # rubocop:disable Metrics/AbcSize
-    output_safe(options[:force])
-    account = ask_check(
-      existing: account, message: I18n.t('message.account'), validator: Awskeyring.method(:account_exists),
-      limited_to: Awskeyring.list_account_names
-    )
-    cred = age_check_and_get(account: account, no_token: options['no-token'])
-    expiry = Time.at(cred[:expiry]) unless cred[:expiry].nil?
-    puts Awskeyring::Awsapi.get_cred_json(
-      key: cred[:key],
-      secret: cred[:secret],
-      token: cred[:token],
-      expiry: (expiry || (Time.new + Awskeyring::Awsapi::ONE_HOUR)).iso8601
-    )
+  def json(account) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    if options[:test]
+      cred = Awskeyring::Awsapi.gen_test_credentials(account: account)
+      puts Awskeyring::Awsapi.get_cred_json(
+        key: cred[:key],
+        secret: cred[:secret],
+        token: cred[:token],
+        expiry: (Time.new + Awskeyring::Awsapi::TWELVE_HOUR).iso8601
+      )
+    else
+      output_safe(options[:force])
+      account = ask_check(
+        existing: account, message: I18n.t('message.account'), validator: Awskeyring.method(:account_exists),
+        limited_to: Awskeyring.list_account_names
+      )
+      cred = age_check_and_get(account: account, no_token: options['no-token'])
+      expiry = Time.at(cred[:expiry]) unless cred[:expiry].nil?
+      puts Awskeyring::Awsapi.get_cred_json(
+        key: cred[:key],
+        secret: cred[:secret],
+        token: cred[:token],
+        expiry: (expiry || (Time.new + Awskeyring::Awsapi::ONE_HOUR)).iso8601
+      )
+    end
   end
 
   desc 'import ACCOUNT', I18n.t('import_desc')

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 2024" "" ""
+.TH "AWSKEYRING" "5" "June 2026" "" ""
 .
 .SH "NAME"
 \fBAwskeyring\fR \- is a small tool to manage AWS account keys in the macOS Keychain
@@ -95,7 +95,10 @@ Outputs bourne shell environment exports for an ACCOUNT
 \-n, \-\-no\-token: Do not use saved token\.
 .
 .br
-\-u, \-\-unset, \-\-no\-unset: Unset environment variables\.
+\-t, \-\-test: Generate test credentials\.
+.
+.br
+\-u, \-\-unset: Unset environment variables\.
 .
 .TP
 exec ACCOUNT command\.\.\.:
@@ -153,6 +156,9 @@ Outputs AWS CLI compatible JSON for an ACCOUNT
 .br
 \-n, \-\-no\-token: Do not use saved token\.
 .
+.br
+\-t, \-\-test: Generate test credentials\.
+.
 .TP
 list:
 .
@@ -347,7 +353,7 @@ The motivation of this application is to provide a local secure store of AWS cre
 If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at \fItristan\.morgan@gmail\.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\.
 .
 .SH "AUTHOR"
-Tristan Morgan \fItristan\.morgan@gmail\.com\fR is the maintainer of Awskeyring\.
+Tristan Morgan \fItristan\.morgan@gmail\.com\fR is the maintainer and author of Awskeyring\.
 .
 .SH "CONTRIBUTORS"
 .

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awskeyring
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.13.1
 platform: ruby
 authors:
 - Tristan Morgan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2026-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam
@@ -92,9 +92,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/tristanmorgan/awskeyring/issues
   changelog_uri: https://github.com/tristanmorgan/awskeyring/blob/main/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/awskeyring/1.12.1
+  documentation_uri: https://rubydoc.info/gems/awskeyring/1.13.1
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/tristanmorgan/awskeyring/tree/v1.12.1
+  source_code_uri: https://github.com/tristanmorgan/awskeyring/tree/v1.13.1
   wiki_uri: https://github.com/tristanmorgan/awskeyring/wiki
 post_install_message: 
 rdoc_options: []