Skip to content

Commit 22267ff

Browse files
author
Ryan Gorup
committed
Add new STS Session credential pulling utility for help use of CodeDeploy IAM Session support
1 parent 258df05 commit 22267ff

File tree

9 files changed

+649
-0
lines changed

9 files changed

+649
-0
lines changed

‎README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ These fall into one of a few different categories, including:
99
- Integrations with load-balancers like Elastic Load Balancing
1010
- Sample hooks for version control systems like Git.
1111

12+
Also included is a utility to pull STS credentials for CodeDeploy's IAM Session support
13+
14+
Note: THe STS Credentials tool may move to its own repo in the future.
15+
1216
License
1317
=======
1418

‎utilities/aws-codedeploy-session-helper/LICENSE

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎utilities/aws-codedeploy-session-helper/README.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# aws-codedeploy-session-helper Tool | get_sts_creds
2+
##Overview
3+
The aws-codedeploy-session-helper get_sts_creds tool enables customers to generate AWS STS credentials and write them to a file. Just provide the aws-codedeploy-session-helper tool some existing credentials and a file location to write the files to, and the tool will retrieve the credential and write them to the requested file. This tool is best paired with static credentials on the box and a cron job to automatically pull the STS credentials.
4+
##Usage
5+
`bin/get_sts_creds` will use existing credentials to retrieve STS credentials, then write the credentials to a file location of your choosing. By default, the session name of the STS credentials is the HOSTNAME of the instance executing the tool. More information about STS credentials can be found [here](http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
6+
```
7+
$ bin/get_sts_creds --help
8+
<displays help>
9+
$ bin/get_sts_creds --role-arn arn:aws:iam::123456789012:role/foo --file /var/tmp/foo
10+
$ cat /var/tmp/foo
11+
[default]
12+
aws_access_key_id = AKIAIOSFODNN7EXAMPLE
13+
aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
14+
aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtpZ3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE
15+
$
16+
```
17+
### Providing credentials to the tool
18+
Credentials can be provided to the tool in a few different ways. Following the AWS Ruby SDK's [documentation](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html), credentials can be provided by exporting environment variables or having the credentials present at a specific file on the box.
19+
#### Environment variables
20+
Linux
21+
```
22+
export AWS_ACCESS_KEY_ID=your_access_key_id
23+
export AWS_SECRET_ACCESS_KEY=your_secret_access_key
24+
```
25+
Windows
26+
```
27+
set AWS_ACCESS_KEY_ID=your_access_key_id
28+
set AWS_SECRET_ACCESS_KEY=your_secret_access_key
29+
```
30+
#### File
31+
File format
32+
```
33+
[default]
34+
aws_access_key_id = your_access_key_id
35+
aws_secret_access_key = your_secret_access_key
36+
```
37+
File location - Linux
38+
```
39+
~/.aws/credentials
40+
```
41+
File location - Windows
42+
```
43+
%HOMEPATH%\.aws\credentials
44+
```
45+
### Working with AWS CodeDeploy
46+
This tool will help customers of [AWS CodeDeploy](https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=0ahUKEwjqoYOU8-LPAhXLsFQKHV4ZDzAQFggeMAA&url=https%3A%2F%2Faws.amazon.com%2Fcodedeploy%2F&usg=AFQjCNFJWFZ0JuuOFbyE390fglFUUi9sXA&sig2=fDXnI7wC1k6B578J-zPDuw)'s OnPremises instance deployment feature by enabling the retrieval and refreshment of the STS credentials that the on premises instance needs. Customers can quickly integrate on premises instances with AWS CodeDeploy by using the AWS CodeDeploy IAM Session support feature [LINK].
47+
48+
You can use this tool with a centralized STS credential broker service distribute credentials to other on premises instances, or deploy a fixed IAM User to each host, then have each host use that IAM user's credentials with this tool to retrieve STS credentials.
49+
50+
When using the `--print-session-arn` flag, you can see the IAM Session ARN that the host will assume. Use this ARN when registering with CodeDeploy. This ARN does not change as long as the arguments to the tool do not change, or the host the tool is running on does not change, as the tool uses the HOSTNAME of the host by default.
51+
52+
## Installation
53+
This tool only requires the Ruby and the aws-sdk-core gem to be installed. This tool can be installed as a ruby gem, or just ran once unzipped via `git clone`.
54+
55+
This has been tested to work with Ruby versions 2.3.1, 2.3.0, 2.2.2, 2.1.10, 2.0.0, and 1.9.3 on Linux.
56+
57+
Note: When using the gem for installation, get_sts_creds will be added to your PATH.
58+
### Amazon Linux
59+
```
60+
// Amazon Linux should have git, ruby, and gem installed
61+
$ gem install aws-sdk-core
62+
$ git clone https://github.com/aws/aws-codedeploy-session-helper.git OR gem install aws-codedeploy-session-helper
63+
$ bin/get_sts_creds <args>
64+
```
65+
### Ubuntu
66+
```
67+
$ sudo apt-get install ruby // if not installed
68+
$ sudo apt-get install rubygems // if not installed. For 14.04, try rubygems-integration
69+
$ sudo apt-get install git // if not installed and using git clone to install instead of gem
70+
$ sudo gem install aws-sdk-core
71+
$ git clone https://github.com/aws/aws-codedeploy-session-helper.git OR gem install aws-codedeploy-session-helper
72+
$ bin/get_sts_creds <args>
73+
```
74+
### Windows
75+
1. Install Ruby from rubyinstaller.org (the 2.3 version comes w/ Gem)
76+
1. `> gem install aws-sdk-core`
77+
1. Install Git from https://git-scm.com/download/win
78+
1. `> git clone https://github.com/aws/aws-codedeploy-session-helper.git` OR `> gem install aws-codedeploy-session-helper`
79+
1. `> chdir <install dir>`
80+
1. `> ruby bin/get_sts_creds <args>`
81+
## Automation
82+
For a Linux machine, you can automate the execution of this tool with the following cron
83+
```
84+
0,15,30,45 * * * * /path/to/tool/bin/get_sts_creds <args>
85+
```
86+
87+
## Testing / Development
88+
If you wish to execute the tests for this tool, you must have the `rspec` and `simplecov` gems installed. Then execute
89+
```
90+
$ cd <aws-codedeploy-session-helper dir>
91+
$ rake
92+
```
93+
The rake task executes syntax checks and tests that cover the CLI's failure cases in addition to the tool's backing library.
94+
95+
To build the gem, just run
96+
97+
```
98+
$ cd <aws-codedeploy-session-helper dir>
99+
$ gem build aws-codedeploy-session-helper.gemspec
100+
```

‎utilities/aws-codedeploy-session-helper/Rakefile

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
require 'rubygems'
2+
require 'rspec/core/rake_task'
3+
4+
task :syntax do
5+
dirs = [ 'bin/*', 'lib/*', 'spec/*']
6+
dirs.each do |d|
7+
ret = check_syntax(d)
8+
exit_code = $?
9+
puts ret
10+
if !(/\ASyntax OK\Z/ =~ ret) or exit_code != 0
11+
puts "Build failed, see above syntax error or warning"
12+
exit(1)
13+
end
14+
end
15+
end
16+
17+
def check_syntax(dir)
18+
return `ruby --verbose -c #{dir} 2>&1`
19+
end
20+
21+
RSpec::Core::RakeTask.new(:spec) do |t|
22+
t.pattern = 'spec/**/*.spec'
23+
end
24+
25+
task :default => [:syntax, :spec]

‎utilities/aws-codedeploy-session-helper/aws-codedeploy-session-helper.gemspec

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Gem::Specification.new do |s|
2+
s.name = 'aws-codedeploy-session-helper'
3+
s.version = '0.9.0'
4+
s.date = '2016-12-27'
5+
s.summary = "This tool helps grab AWS STS credentials, useful when using CodeDeploy OnPremises instances with IAM Sessions."
6+
s.description = "See readme of the code on GitHub, https://github.com/aws-labs/aws-codedeploy-samples/tree/master/utilities/aws-codedeploy-session-helper"
7+
s.authors = ["Ryan Gorup"]
8+
s.email = '[email protected]'
9+
s.files = ["lib/STSCredentialsProvider.rb"]
10+
s.executables = ["get_sts_creds"]
11+
s.homepage =
12+
'https://github.com/aws-labs/aws-codedeploy-samples/tree/master/utilities/aws-codedeploy-session-helper'
13+
s.license = 'Apache-2.0'
14+
15+
s.add_runtime_dependency('aws-sdk-core', '~> 2.6')
16+
s.add_development_dependency('rake', '~> 0.9')
17+
s.add_development_dependency('simplecov', '~> 0.12')
18+
s.add_development_dependency('rspec', '~> 3.5')
19+
end

‎utilities/aws-codedeploy-session-helper/bin/get_sts_creds

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
#!/usr/bin/env ruby
2+
3+
require 'optparse'
4+
require File.expand_path('../../lib/STSCredentialsProvider', __FILE__)
5+
6+
# Setup parser
7+
options = {}
8+
OptionParser.new do |parser|
9+
parser.banner = "Usage: get_sts_creds --role-arn ROLE_ARN --file FILEPATH [options]"
10+
parser.on("-h", "--help", "Show this help message", "\tNote: Pass credentials using environment variables or credentials file, see http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html") do ||
11+
puts parser
12+
exit
13+
end
14+
15+
parser.on("--role-arn ROLE_ARN", "[required] The IAM ARN that the AWS IAM Role that the session credentials will assume",
16+
"\tExample: '--role-arn arn:aws:iam::123456789012:role/FooRole'") do |v|
17+
options[:role] = v
18+
end
19+
parser.on("--file FILEPATH", "[required] The fully qualified file path that the session credentials will be writen to",
20+
"\tExample: '--file /foo/baz/aws_session_creds'") do |v|
21+
options[:creds_file] = v
22+
end
23+
parser.on("--region REGION", "The AWS region for configuring outbound AWS calls",
24+
"By default, this tool will check the AWS_REGION environment variable", "\tExample: '--region us-east-1'") do |v|
25+
options[:region] = v
26+
end
27+
parser.on("--session-name-override SESSION_NAME", "The name for the IAM Session that will be included in the AWS STS Session ARN",
28+
"By default, this tool will use the HOSTNAME of the current.",
29+
"\tExample: '--session-name-override test-session'") do |v|
30+
options[:session_name] = v
31+
end
32+
parser.on("--duration SECONDS", "The duration (in seconds) of the life of the session credentials that this tool generates",
33+
"Defaults to 3600, or one hour. Value must be between 900 and 3600",
34+
"\tExample: '--duration 1800'") do |v|
35+
options[:duration] = v
36+
end
37+
parser.on("--print-session-arn", "Provide this flag to have the tool output (STDOUT) the ARN of the STS Session",
38+
"Defaults to not printing arn") do |v|
39+
options[:output_arn] = v
40+
end
41+
end.parse!
42+
43+
provider = STSCredentialsProvider.new(options)
44+
provider.get

0 commit comments

Comments
 (0)