awskeyring 1.8.1 → 1.8.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6f414457dbb053f2bbe8fde789ee2238ed11d3554576bfbd67ff52c84697eb5b
4
- data.tar.gz: 70766a2e47f57dccd562a604d278bfa248b6133b7aa5f6f6a0c697bd2fd09cdc
3
+ metadata.gz: 821682d536efc3d5785f862fb8e1a53fda4107eb18020bc6b3796a1d3654ee7d
4
+ data.tar.gz: 79bda10be2bfdabb9142e9798cfcdd47a20eba1b1cc4186526ca2f2860253514
5
5
  SHA512:
6
- metadata.gz: 6a14c818ec8f52ad3b0520d779c047eb2523252d9ebc032005571ed347fe3a66f3015e7cc5f7f64a0ff36845ea4c7232e5c70f64da171b5e489bc01b1be6b525
7
- data.tar.gz: bbd9103d268378c1901097854df9880d6b5dc32843feb24e654faff26d8dfd8952862cfb48c492c290cd88b87ee6897c4ad8a8f1407dc0c22a8207b32f1c34d3
6
+ metadata.gz: a84c3ef0c53bdf13a5740e1231494700bd40b91acda358c27c99de2eb8170c8073d98536c3fdfd6973a8f80cf2c3b362b101de83a5415eebada7b3a7f391053c
7
+ data.tar.gz: 728d2d23bd55a416d39bb94dbc5f7445941a15a64a18ef6f2a070ac6a21a6c9d4b14f3e0f210e6b85a964c08070c5435fc301665d4d6fd4989fe411dfed29efd
data/LICENSE.txt CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2017-2020 Tristan Morgan
3
+ Copyright (c) 2017-2021 Tristan Morgan
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ![Awskeyring](https://raw.githubusercontent.com/servian/awskeyring/main/awskeyring-144.png)
4
4
 
5
- * [![Build Status](https://travis-ci.org/servian/awskeyring.svg?branch=main)](https://travis-ci.org/servian/awskeyring)
5
+ * [![Build Status](https://travis-ci.com/servian/awskeyring.svg?branch=main)](https://travis-ci.com/servian/awskeyring)
6
6
  * [![Gem Version](https://badge.fury.io/rb/awskeyring.svg)](https://badge.fury.io/rb/awskeyring)
7
7
  * [![license MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
8
8
  * [![All Downloads](https://ruby-gem-downloads-badge.herokuapp.com/awskeyring?type=total)](https://rubygems.org/gems/awskeyring)
data/Rakefile CHANGED
@@ -59,4 +59,5 @@ YARD::Rake::YardocTask.new do |t|
59
59
  t.stats_options = ['--list-undoc']
60
60
  end
61
61
 
62
+ desc 'Run Linting, Tests and Documetation tasks'
62
63
  task default: %i[filemode rubocop spec ronn yard]
data/awskeyring.gemspec CHANGED
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
15
15
  spec.homepage = Awskeyring::HOMEPAGE
16
16
  spec.licenses = ['MIT']
17
17
 
18
- spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/|^\..*|^.*\.png}) }
18
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/|^\..*|C.*\.md|.*\.ronn|.*\.png}) }
19
19
  spec.bindir = 'exe'
20
20
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
21
  spec.require_paths = ['lib']
@@ -6,7 +6,7 @@ require 'json'
6
6
  # Version const and query of latest.
7
7
  module Awskeyring
8
8
  # The Gem's version number
9
- VERSION = '1.8.1'
9
+ VERSION = '1.8.2'
10
10
  # The Gem's homepage
11
11
  HOMEPAGE = 'https://github.com/servian/awskeyring'
12
12
 
@@ -16,17 +16,17 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
16
16
 
17
17
  map %w[--version -v] => :__version
18
18
  map %w[--help -h] => :help
19
- map ['init'] => :initialise
20
- map ['adr'] => :add_role
21
- map ['con'] => :console
22
- map ['ls'] => :list
23
- map ['lsr'] => :list_role
24
- map ['rm'] => :remove
25
- map ['rmr'] => :remove_role
26
- map ['rmt'] => :remove_token
27
- map ['rot'] => :rotate
28
- map ['tok'] => :token
29
- map ['up'] => :update
19
+ map 'init' => :initialise
20
+ map 'adr' => :add_role
21
+ map 'con' => :console
22
+ map 'ls' => :list
23
+ map 'lsr' => :list_role
24
+ map 'rm' => :remove
25
+ map 'rmr' => :remove_role
26
+ map 'rmt' => :remove_token
27
+ map 'rot' => :rotate
28
+ map 'tok' => :token
29
+ map 'up' => :update
30
30
 
31
31
  # default to returning an error on failure.
32
32
  def self.exit_on_failure?
@@ -425,8 +425,9 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
425
425
  end
426
426
 
427
427
  desc 'awskeyring CURR PREV', I18n.t('awskeyring.desc'), hide: true
428
+ map File.basename($PROGRAM_NAME) => :autocomplete
428
429
  # autocomplete
429
- def awskeyring(curr, prev)
430
+ def autocomplete(curr, prev)
430
431
  comp_line = ENV['COMP_LINE']
431
432
  unless comp_line
432
433
  exec_name = File.basename($PROGRAM_NAME)
@@ -506,7 +507,7 @@ class AwskeyringCommand < Thor # rubocop:disable Metrics/ClassLength
506
507
  end
507
508
 
508
509
  def list_commands
509
- self.class.all_commands.keys.map { |elem| elem.tr('_', '-') }.reject! { |elem| elem == 'awskeyring' }
510
+ self.class.all_commands.keys.map { |elem| elem.tr('_', '-') }.reject! { |elem| elem == 'autocomplete' }
510
511
  end
511
512
 
512
513
  def list_arguments(command:)
data/man/awskeyring.5 CHANGED
@@ -1,7 +1,7 @@
1
1
  .\" generated with Ronn/v0.7.3
2
2
  .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
3
  .
4
- .TH "AWSKEYRING" "5" "November 2020" "" ""
4
+ .TH "AWSKEYRING" "5" "March 2021" "" ""
5
5
  .
6
6
  .SH "NAME"
7
7
  \fBAwskeyring\fR \- is a small tool to manage AWS account keys in the macOS Keychain
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: awskeyring
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.1
4
+ version: 1.8.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tristan Morgan
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-01-20 00:00:00.000000000 Z
11
+ date: 2021-03-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-iam
@@ -73,14 +73,10 @@ executables:
73
73
  extensions: []
74
74
  extra_rdoc_files: []
75
75
  files:
76
- - CHANGELOG.md
77
- - CODE_OF_CONDUCT.md
78
- - CONTRIBUTING.md
79
76
  - Gemfile
80
77
  - LICENSE.txt
81
78
  - README.md
82
79
  - Rakefile
83
- - SECURITY.md
84
80
  - awskeyring.gemspec
85
81
  - exe/awskeyring
86
82
  - i18n/en.yml
@@ -91,15 +87,14 @@ files:
91
87
  - lib/awskeyring/version.rb
92
88
  - lib/awskeyring_command.rb
93
89
  - man/awskeyring.5
94
- - man/awskeyring.5.ronn
95
90
  homepage: https://github.com/servian/awskeyring
96
91
  licenses:
97
92
  - MIT
98
93
  metadata:
99
94
  bug_tracker_uri: https://github.com/servian/awskeyring/issues
100
95
  changelog_uri: https://github.com/servian/awskeyring/blob/main/CHANGELOG.md
101
- documentation_uri: https://rubydoc.info/gems/awskeyring/1.8.1
102
- source_code_uri: https://github.com/servian/awskeyring/tree/v1.8.1
96
+ documentation_uri: https://rubydoc.info/gems/awskeyring/1.8.2
97
+ source_code_uri: https://github.com/servian/awskeyring/tree/v1.8.2
103
98
  wiki_uri: https://github.com/servian/awskeyring/wiki
104
99
  post_install_message:
105
100
  rdoc_options: []
data/CHANGELOG.md DELETED
@@ -1,164 +0,0 @@
1
- # Changelog
2
-
3
- ## [v1.8.1](https://github.com/servian/awskeyring/tree/v1.8.1) (2021-01-20)
4
-
5
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.8.0...v1.8.1)
6
-
7
- **Fixed bugs:**
8
-
9
- - Update command failed. [\#75](https://github.com/servian/awskeyring/issues/75)
10
-
11
- **Merged pull requests:**
12
-
13
- - Default nil token \(fix \#75\) [\#76](https://github.com/servian/awskeyring/pull/76) ([tristanmorgan](https://github.com/tristanmorgan))
14
-
15
- ## [v1.8.0](https://github.com/servian/awskeyring/tree/v1.8.0) (2020-12-07)
16
-
17
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.7.0...v1.8.0)
18
-
19
- **Implemented enhancements:**
20
-
21
- - Include expiry time export, AWS\_CREDENTIAL\_EXPIRATION [\#74](https://github.com/servian/awskeyring/pull/74) ([tristanmorgan](https://github.com/tristanmorgan))
22
-
23
- ## [v1.7.0](https://github.com/servian/awskeyring/tree/v1.7.0) (2020-11-18)
24
-
25
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.6.0...v1.7.0)
26
-
27
- **Implemented enhancements:**
28
-
29
- - Allow specifying a browser other than the default [\#71](https://github.com/servian/awskeyring/issues/71)
30
- - Autocomplete for Browsers [\#73](https://github.com/servian/awskeyring/pull/73) ([tristanmorgan](https://github.com/tristanmorgan))
31
-
32
- **Merged pull requests:**
33
-
34
- - Updates for added RuboCop checks. [\#70](https://github.com/servian/awskeyring/pull/70) ([tristanmorgan](https://github.com/tristanmorgan))
35
-
36
- ## [v1.6.0](https://github.com/servian/awskeyring/tree/v1.6.0) (2020-08-11)
37
-
38
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.5.0...v1.6.0)
39
-
40
- **Implemented enhancements:**
41
-
42
- - Warn about missing accounts/roles [\#69](https://github.com/servian/awskeyring/pull/69) ([tristanmorgan](https://github.com/tristanmorgan))
43
- - RuboCop and Spec update [\#68](https://github.com/servian/awskeyring/pull/68) ([tristanmorgan](https://github.com/tristanmorgan))
44
- - Add SimpleCov reports. [\#67](https://github.com/servian/awskeyring/pull/67) ([tristanmorgan](https://github.com/tristanmorgan))
45
-
46
- ## [v1.5.0](https://github.com/servian/awskeyring/tree/v1.5.0) (2020-07-08)
47
-
48
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.4.0...v1.5.0)
49
-
50
- **Implemented enhancements:**
51
-
52
- - No-Bundle env changes for exec. [\#66](https://github.com/servian/awskeyring/pull/66) ([tristanmorgan](https://github.com/tristanmorgan))
53
-
54
- ## [v1.4.0](https://github.com/servian/awskeyring/tree/v1.4.0) (2020-06-19)
55
-
56
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.3...v1.4.0)
57
-
58
- **Implemented enhancements:**
59
-
60
- - Import Keys and Tokens from shared credentials files. [\#65](https://github.com/servian/awskeyring/pull/65) ([tristanmorgan](https://github.com/tristanmorgan))
61
-
62
- ## [v1.3.3](https://github.com/servian/awskeyring/tree/v1.3.3) (2020-06-04)
63
-
64
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.2...v1.3.3)
65
-
66
- **Implemented enhancements:**
67
-
68
- - Change email references from Vibrato to Servian [\#64](https://github.com/servian/awskeyring/pull/64) ([tristanmorgan](https://github.com/tristanmorgan))
69
-
70
- ## [v1.3.2](https://github.com/servian/awskeyring/tree/v1.3.2) (2020-04-27)
71
-
72
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.1...v1.3.2)
73
-
74
- **Fixed bugs:**
75
-
76
- - Fix I18n message load when used as a library. [\#63](https://github.com/servian/awskeyring/pull/63) ([tristanmorgan](https://github.com/tristanmorgan))
77
-
78
- ## [v1.3.1](https://github.com/servian/awskeyring/tree/v1.3.1) (2020-03-19)
79
-
80
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.3.0...v1.3.1)
81
-
82
- **Implemented enhancements:**
83
-
84
- - Markdown linting changes and removed Rubocop-MD. [\#61](https://github.com/servian/awskeyring/pull/61) ([tristanmorgan](https://github.com/tristanmorgan))
85
- - Removed some redundant code. [\#60](https://github.com/servian/awskeyring/pull/60) ([tristanmorgan](https://github.com/tristanmorgan))
86
-
87
- **Merged pull requests:**
88
-
89
- - Update Ronn code and PR template. [\#59](https://github.com/servian/awskeyring/pull/59) ([tristanmorgan](https://github.com/tristanmorgan))
90
-
91
- ## [v1.3.0](https://github.com/servian/awskeyring/tree/v1.3.0) (2020-02-19)
92
-
93
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.2.0...v1.3.0)
94
-
95
- **Implemented enhancements:**
96
-
97
- - Add a man-page and tweak README. [\#58](https://github.com/servian/awskeyring/pull/58) ([tristanmorgan](https://github.com/tristanmorgan))
98
- - Enhanced version [\#57](https://github.com/servian/awskeyring/pull/57) ([AzySir](https://github.com/AzySir))
99
-
100
- ## [v1.2.0](https://github.com/servian/awskeyring/tree/v1.2.0) (2020-01-20)
101
-
102
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.1.2...v1.2.0)
103
-
104
- **Implemented enhancements:**
105
-
106
- - Check for existing account keys and role arns [\#56](https://github.com/servian/awskeyring/pull/56) ([tristanmorgan](https://github.com/tristanmorgan))
107
-
108
- ## [v1.1.2](https://github.com/servian/awskeyring/tree/v1.1.2) (2020-01-06)
109
-
110
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.1.1...v1.1.2)
111
-
112
- **Fixed bugs:**
113
-
114
- - Deprecation warning for exit\_on\_failure [\#55](https://github.com/servian/awskeyring/pull/55) ([tristanmorgan](https://github.com/tristanmorgan))
115
-
116
- ## [v1.1.1](https://github.com/servian/awskeyring/tree/v1.1.1) (2019-11-27)
117
-
118
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.1.0...v1.1.1)
119
-
120
- **Implemented enhancements:**
121
-
122
- - Add --detail flag for roles. [\#54](https://github.com/servian/awskeyring/pull/54) ([tristanmorgan](https://github.com/tristanmorgan))
123
-
124
- ## [v1.1.0](https://github.com/servian/awskeyring/tree/v1.1.0) (2019-11-06)
125
-
126
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.0.2...v1.1.0)
127
-
128
- **Implemented enhancements:**
129
-
130
- - Add completion to input prompts [\#53](https://github.com/servian/awskeyring/pull/53) ([tristanmorgan](https://github.com/tristanmorgan))
131
- - Check for existing \(or not\) role names [\#52](https://github.com/servian/awskeyring/pull/52) ([tristanmorgan](https://github.com/tristanmorgan))
132
-
133
- ## [v1.0.2](https://github.com/servian/awskeyring/tree/v1.0.2) (2019-10-18)
134
-
135
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.0.1...v1.0.2)
136
-
137
- **Implemented enhancements:**
138
-
139
- - Move to a new home, Servian. [\#51](https://github.com/servian/awskeyring/pull/51) ([tristanmorgan](https://github.com/tristanmorgan))
140
- - Use RuboCop-RSpec too and expect\(\) more. [\#48](https://github.com/servian/awskeyring/pull/48) ([tristanmorgan](https://github.com/tristanmorgan))
141
-
142
- ## [v1.0.1](https://github.com/servian/awskeyring/tree/v1.0.1) (2019-05-23)
143
-
144
- [Full Changelog](https://github.com/servian/awskeyring/compare/v1.0.0...v1.0.1)
145
-
146
- **Implemented enhancements:**
147
-
148
- - auto-complete the --version [\#47](https://github.com/servian/awskeyring/pull/47) ([tristanmorgan](https://github.com/tristanmorgan))
149
-
150
- **Fixed bugs:**
151
-
152
- - Unfreeze secret strings. [\#46](https://github.com/servian/awskeyring/pull/46) ([tristanmorgan](https://github.com/tristanmorgan))
153
-
154
- ## [v1.0.0](https://github.com/servian/awskeyring/tree/v1.0.0) (2019-05-19)
155
-
156
- [Full Changelog](https://github.com/servian/awskeyring/compare/v0.10.0...v1.0.0)
157
-
158
- **Implemented enhancements:**
159
-
160
- - More RuboCop changes and tweaked version string. [\#45](https://github.com/servian/awskeyring/pull/45) ([tristanmorgan](https://github.com/tristanmorgan))
161
-
162
-
163
-
164
- \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
data/CODE_OF_CONDUCT.md DELETED
@@ -1,73 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as
6
- contributors and maintainers pledge to making participation in our project and
7
- our community a harassment-free experience for everyone, regardless of age, body
8
- size, disability, ethnicity, gender identity and expression, level of experience,
9
- education, socio-economic status, nationality, personal appearance, race,
10
- religion, or sexual identity and orientation.
11
-
12
- ## Our Standards
13
-
14
- Examples of behavior that contributes to creating a positive environment
15
- include:
16
-
17
- * Using welcoming and inclusive language
18
- * Being respectful of differing viewpoints and experiences
19
- * Gracefully accepting constructive criticism
20
- * Focusing on what is best for the community
21
- * Showing empathy towards other community members
22
-
23
- Examples of unacceptable behavior by participants include:
24
-
25
- * The use of sexualized language or imagery and unwelcome sexual attention or
26
- advances
27
- * Trolling, insulting/derogatory comments, and personal or political attacks
28
- * Public or private harassment
29
- * Publishing others' private information, such as a physical or electronic
30
- address, without explicit permission
31
- * Other conduct which could reasonably be considered inappropriate in a
32
- professional setting
33
-
34
- ## Our Responsibilities
35
-
36
- Project maintainers are responsible for clarifying the standards of acceptable
37
- behavior and are expected to take appropriate and fair corrective action in
38
- response to any instances of unacceptable behavior.
39
-
40
- Project maintainers have the right and responsibility to remove, edit, or
41
- reject comments, commits, code, wiki edits, issues, and other contributions
42
- that are not aligned to this Code of Conduct, or to ban temporarily or
43
- permanently any contributor for other behaviors that they deem inappropriate,
44
- threatening, offensive, or harmful.
45
-
46
- ## Scope
47
-
48
- This Code of Conduct applies both within project spaces and in public spaces
49
- when an individual is representing the project or its community. Examples of
50
- representing a project or community include using an official project e-mail
51
- address, posting via an official social media account, or acting as an appointed
52
- representative at an online or offline event. Representation of a project may be
53
- further defined and clarified by project maintainers.
54
-
55
- ## Enforcement
56
-
57
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
- reported by contacting the project team at [tristan.morgan@servian.com](mailto:tristan.morgan@servian.com). All
59
- complaints will be reviewed and investigated and will result in a response that
60
- is deemed necessary and appropriate to the circumstances. The project team is
61
- obligated to maintain confidentiality with regard to the reporter of an incident.
62
- Further details of specific enforcement policies may be posted separately.
63
-
64
- Project maintainers who do not follow or enforce the Code of Conduct in good
65
- faith may face temporary or permanent repercussions as determined by other
66
- members of the project's leadership.
67
-
68
- ## Attribution
69
-
70
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
- available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
72
-
73
- [homepage]: https://www.contributor-covenant.org
data/CONTRIBUTING.md DELETED
@@ -1,48 +0,0 @@
1
- # How to contribute
2
-
3
- Bug reports and pull requests from users are what keep this project working.
4
-
5
- ## Basics
6
-
7
- 1. Create an issue and describe your idea
8
- 2. [Fork it](https://github.com/servian/awskeyring/fork)
9
- 3. Create your feature branch (`git checkout -b my-new-feature`)
10
- 4. Commit your changes (`git commit -am 'Add some feature'`)
11
- 5. Publish the branch (`git push origin my-new-feature`)
12
- 6. Create a new Pull Request
13
-
14
- ## Checking your work
15
-
16
- You can run the test suite.
17
-
18
- You can run [RuboCop] to check code style.
19
-
20
- You can run [RSpec] to see if anything broke.
21
-
22
- You can run [YARD] to see of your code is documented.
23
-
24
- The default Rake task, runnable using `rake`.
25
-
26
- ## Write documentation
27
-
28
- This project has documentation in a few places:
29
-
30
- ### Introduction and usage
31
-
32
- A friendly `README.md` written for many audiences.
33
-
34
- ### Examples and advanced usage
35
-
36
- The [wiki].
37
-
38
- ### API documentation
39
-
40
- API documentation is written as [YARD] docblocks in the Ruby code.
41
-
42
- This is rendered as Web pages on [Rubydoc.info][awskeyring on Rubydoc.info].
43
-
44
- [wiki]: https://github.com/servian/awskeyring/wiki
45
- [YARD]: https://yardoc.org/
46
- [awskeyring on Rubydoc.info]: https://www.rubydoc.info/gems/awskeyring
47
- [RuboCop]: https://rubocop.readthedocs.io/en/latest/
48
- [Rspec]: https://rspec.info
data/SECURITY.md DELETED
@@ -1,4 +0,0 @@
1
- # Security Policy
2
-
3
- If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at
4
- [tristan.morgan@servian.com](mailto:tristan.morgan@servian.com).
@@ -1,175 +0,0 @@
1
- # Awskeyring -- is a small tool to manage AWS account keys in the macOS Keychain
2
-
3
- ## SYNOPSIS
4
-
5
- awskeyring COMMAND [ACCOUNT|ROLE] [OPTIONS]
6
-
7
- awskeyring help COMMAND
8
-
9
- ## DESCRIPTION
10
-
11
- The Awskeyring utility stores and manages AWS access keys and provides the facility to generate access tokens with
12
- combinations of assumed roles and multi-factor-authentication codes. It includes autocompletion features and multiple
13
- validation checks for input parsing. It also includes the ability for the AWS CLI to call it directly to provide authentication.
14
-
15
- The commands are as follows:
16
-
17
- * --version, -v:
18
-
19
- Prints the version<br>
20
-
21
- -r, --no-remote: Do not validate with remote api.
22
-
23
- * add ACCOUNT:
24
-
25
- Adds an ACCOUNT to the keyring<br>
26
-
27
- -k, --key=KEY: AWS account key id.<br>
28
- -s, --secret=SECRET: AWS account secret.<br>
29
- -m, --mfa=MFA: AWS virtual mfa arn.<br>
30
- -r, --no-remote: Do not validate with remote api.
31
-
32
- * add-role ROLE:
33
-
34
- Adds a ROLE to the keyring<br>
35
-
36
- -a, --arn=ARN: AWS role arn.
37
-
38
- * awskeyring console ACCOUNT:
39
-
40
- Open the AWS Console for the ACCOUNT<br>
41
-
42
- -p, --path=PATH: The service PATH to open.<br>
43
- -b, --browser=BROWSER: Specify an alternative browser.<br>
44
- -n, --no-token: Do not use saved token.<br>
45
- -o, --no-open: Do not open the url.
46
-
47
- * env ACCOUNT:
48
-
49
- Outputs bourne shell environment exports for an ACCOUNT<br>
50
-
51
- -n, --no-token: Do not use saved token.<br>
52
- -u, --unset, --no-unset: Unset environment variables.
53
-
54
- * exec ACCOUNT command...:
55
-
56
- Execute a COMMAND with the environment set for an ACCOUNT<br>
57
-
58
- -n, --no-token: Do not use saved token.<br>
59
- -b, --no-bundle: Unset Bundler environment variables.
60
-
61
- * help [COMMAND]:
62
-
63
- Describe available commands or one specific command
64
-
65
- * import:
66
-
67
- Import an ACCOUNT to the keyring from ~/.aws/credentials<br>
68
-
69
- -r, --no-remote: Do not validate with remote api.
70
-
71
- * initialise:
72
-
73
- Initialises a new KEYCHAIN<br>
74
-
75
- -n, --keychain=KEYCHAIN: Name of KEYCHAIN to initialise.
76
-
77
- * json ACCOUNT:
78
-
79
- Outputs AWS CLI compatible JSON for an ACCOUNT<br>
80
-
81
- -n, --no-token: Do not use saved token.
82
-
83
- * list:
84
-
85
- Prints a list of accounts in the keyring
86
-
87
- * list-role:
88
-
89
- Prints a list of roles in the keyring<br>
90
-
91
- -d, --detail, --no-detail: Show more detail.
92
-
93
- * remove ACCOUNT:
94
-
95
- Removes an ACCOUNT from the keyring
96
-
97
- * remove-role ROLE:
98
-
99
- Removes a ROLE from the keyring
100
-
101
- * remove-token ACCOUNT:
102
-
103
- Removes a token for ACCOUNT from the keyring
104
-
105
- * rotate ACCOUNT:
106
-
107
- Rotate access keys for an ACCOUNT
108
-
109
- * token ACCOUNT [ROLE] [MFA]:
110
-
111
- Create an STS Token from a ROLE or an MFA code<br>
112
-
113
- -r, --role=ROLE: The ROLE to assume.<br>
114
- -c, --code=CODE: Virtual mfa CODE.<br>
115
- -d, --duration=DURATION: Session DURATION in seconds.
116
-
117
- * update ACCOUNT:
118
-
119
- Updates an ACCOUNT in the keyring<br>
120
-
121
- -k, --key=KEY: AWS account key id.<br>
122
- -s, --secret=SECRET: AWS account secret.<br>
123
- -r, --no-remote: Do not validate with remote api.
124
-
125
- ## ENVIRONMENT
126
-
127
- The AWS_DEFAULT_REGION environment variable will be used for AWS API calls where specified or fall back to us-east-1
128
- when not.
129
-
130
- ## EXIT STATUS
131
-
132
- The Awskeyring utility exits 0 on success, and >0 if an error occurs.
133
-
134
- ## EXAMPLES
135
-
136
- First you need to initialise your keychain to hold your AWS credentials.
137
-
138
- awskeyring initialise
139
-
140
- Then add your keys to it.
141
-
142
- awskeyring add personal-aws
143
-
144
- Now your keys are stored safely in the macOS keychain. To print environment variables run...
145
-
146
- awskeyring env personal-aws
147
-
148
- ## HISTORY
149
-
150
- The motivation of this application is to provide a local secure store of AWS
151
- credentials using specifically in the macOS Keychain, to have them easily accessed
152
- from the Terminal, and to provide useful functions like assuming roles and opening
153
- the AWS Console from the cli.
154
- For Enterprise environments there are better suited tools to use
155
- like [HashiCorp Vault](https://vaultproject.io/).
156
-
157
- ## SECURITY
158
-
159
- If you believe you have found a security issue in Awskeyring, please responsibly disclose by contacting me at
160
- [tristan.morgan@servian.com](mailto:tristan.morgan@servian.com). Awskeyring is a Ruby script and as such Ruby is whitelisted to
161
- access your "awskeyring" keychain. Use a strong password and keep the unlock time short.
162
-
163
- ## AUTHOR
164
-
165
- Tristan Morgan <tristan.morgan@servian.com> is the maintainer of Awskeyring.
166
-
167
- ## CONTRIBUTORS
168
-
169
- * Tristan [tristanmorgan](https://github.com/tristanmorgan)
170
- * Adam Sir [AzySir](https://github.com/AzySir)
171
- * Vito Giarrusso [thtliife](https://github.com/thtliife)
172
-
173
- ## LICENSE
174
-
175
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).