s3-secure 0.4.2 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/LICENSE.txt +201 -22
  4. data/README.md +39 -14
  5. data/lib/s3_secure/access_logs/base.rb +4 -0
  6. data/lib/s3_secure/access_logs/disable.rb +37 -0
  7. data/lib/s3_secure/access_logs/enable.rb +41 -0
  8. data/lib/s3_secure/access_logs/list.rb +25 -0
  9. data/lib/s3_secure/access_logs/show.rb +89 -0
  10. data/lib/s3_secure/aws_services/s3.rb +61 -0
  11. data/lib/s3_secure/aws_services.rb +4 -30
  12. data/lib/s3_secure/backwards_compatibility.rb +20 -0
  13. data/lib/s3_secure/cli/access_logs.rb +32 -0
  14. data/lib/s3_secure/{abstract_base.rb → cli/base.rb} +4 -3
  15. data/lib/s3_secure/{batch.rb → cli/batch.rb} +1 -1
  16. data/lib/s3_secure/{encryption.rb → cli/encryption.rb} +10 -6
  17. data/lib/s3_secure/cli/help.rb +11 -0
  18. data/lib/s3_secure/cli/lifecycle.rb +33 -0
  19. data/lib/s3_secure/cli/policy.rb +31 -0
  20. data/lib/s3_secure/cli/public_access.rb +32 -0
  21. data/lib/s3_secure/cli/remediate_all.rb +12 -0
  22. data/lib/s3_secure/cli/say.rb +7 -0
  23. data/lib/s3_secure/{summary.rb → cli/summary.rb} +3 -3
  24. data/lib/s3_secure/cli/versioning.rb +31 -0
  25. data/lib/s3_secure/cli.rb +25 -3
  26. data/lib/s3_secure/command.rb +7 -0
  27. data/lib/s3_secure/encryption/base.rb +2 -2
  28. data/lib/s3_secure/encryption/disable.rb +6 -10
  29. data/lib/s3_secure/encryption/enable.rb +6 -12
  30. data/lib/s3_secure/encryption/list.rb +13 -17
  31. data/lib/s3_secure/encryption/show.rb +16 -10
  32. data/lib/s3_secure/help/batch.md +14 -0
  33. data/lib/s3_secure/help/encryption/list.md +5 -0
  34. data/lib/s3_secure/help/lifecycle/add.md +13 -0
  35. data/lib/s3_secure/help/lifecycle/list.md +22 -0
  36. data/lib/s3_secure/help/lifecycle/remove.md +5 -0
  37. data/lib/s3_secure/help/lifecycle/show.md +13 -0
  38. data/lib/s3_secure/help/policy/list.md +5 -0
  39. data/lib/s3_secure/lifecycle/add.rb +33 -0
  40. data/lib/s3_secure/lifecycle/base.rb +5 -0
  41. data/lib/s3_secure/lifecycle/builder.rb +47 -0
  42. data/lib/s3_secure/lifecycle/list.rb +24 -0
  43. data/lib/s3_secure/lifecycle/remove.rb +28 -0
  44. data/lib/s3_secure/lifecycle/show.rb +40 -0
  45. data/lib/s3_secure/policy/base.rb +2 -2
  46. data/lib/s3_secure/policy/checker.rb +1 -1
  47. data/lib/s3_secure/policy/document.rb +1 -1
  48. data/lib/s3_secure/policy/enforce.rb +7 -11
  49. data/lib/s3_secure/policy/list.rb +14 -18
  50. data/lib/s3_secure/policy/show.rb +12 -11
  51. data/lib/s3_secure/policy/unforce.rb +8 -11
  52. data/lib/s3_secure/public_access/base.rb +10 -0
  53. data/lib/s3_secure/public_access/block.rb +18 -0
  54. data/lib/s3_secure/public_access/list.rb +24 -0
  55. data/lib/s3_secure/public_access/show.rb +27 -0
  56. data/lib/s3_secure/public_access/unblock.rb +12 -0
  57. data/lib/s3_secure/summary/item.rb +1 -1
  58. data/lib/s3_secure/summary/items.rb +6 -9
  59. data/lib/s3_secure/version.rb +1 -1
  60. data/lib/s3_secure/versioning/base.rb +4 -0
  61. data/lib/s3_secure/versioning/disable.rb +19 -0
  62. data/lib/s3_secure/versioning/enable.rb +19 -0
  63. data/lib/s3_secure/versioning/list.rb +24 -0
  64. data/lib/s3_secure/versioning/show.rb +27 -0
  65. data/lib/s3_secure.rb +6 -2
  66. data/s3-secure.gemspec +6 -3
  67. data/spec/lib/lifecycle/builder_spec.rb +85 -0
  68. metadata +77 -11
  69. data/lib/s3_secure/help.rb +0 -9
  70. data/lib/s3_secure/policy.rb +0 -27
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f990c19df8d1e76dddcdba7b3b3bde118835f002cad7fa83d88174ce73f5ec94
4
- data.tar.gz: e6fe39ed79c6e81962ae003d4b4591d7baa0ab886538a0ee77fa0e7c3a43c2d1
3
+ metadata.gz: 81fe28ce4e04c9166c7749651687a6ae0978ecdb062bc0a18ddd545cd5a04fc9
4
+ data.tar.gz: 63e946c07d0e16390be21e8cf14a383e47ac61ae3297eb9ae5c5bd874916684e
5
5
  SHA512:
6
- metadata.gz: a681ba106ada2376c3a9683b6b412eb6c6df5de7f7ce9d550b11b700d248be850fda0e7c71c976feb3040854d33681e8d4c51c7aa32883d9ab5fe73d16ed0afb
7
- data.tar.gz: 539bc7cb06025cca7c21fa88fd9a26b68b62aa773723f0eca618d3b24c4e4d3a983c5bbd61f7dab6c242b08ad56074805cb4bcced462195d3d3bf97cc5fee3ec
6
+ metadata.gz: 77d3dc78e56b5865a52afb29c0bfea7047bd5598c3907ea52a85026b88afd1aec2b391662b3c314c1aff781268cb4aea6d2235eeff6aad2e81009add955cda29
7
+ data.tar.gz: 94702656cce8a2bcfd7e36b640f582024ec98f18889e084bdc60a51558401eaf142f55a1ad0440843e55c5bd5d55169a114c0d6a8dbac2de0c36739f27b7b91f
data/CHANGELOG.md CHANGED
@@ -3,6 +3,21 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
5
5
 
6
+ ## [0.6.1] - 2021-12-30
7
+ - [#6](https://github.com/tongueroo/s3-secure/pull/6) maintain backward compatibility terraspace_plugin_aws
8
+
9
+ ## [0.6.0] - 2021-12-30
10
+ - [#4](https://github.com/tongueroo/s3-secure/pull/4) refactor move directly related cli classes to subfolder
11
+ - [#5](https://github.com/tongueroo/s3-secure/pull/5) add public access block support
12
+ - fix activesupport require
13
+
14
+ ## [0.5.1]
15
+ - #3 add quiet option
16
+
17
+ ## [0.5.0]
18
+ - add commands: access_logs, lifecycle, versioning, remediate_all
19
+ - s3 client is smarter and switches regions on a per-bucket basis
20
+
6
21
  ## [0.4.2]
7
22
  - improve error message for Aws::STS::Errors::RegionDisabledException error
8
23
 
data/LICENSE.txt CHANGED
@@ -1,22 +1,201 @@
1
- Copyright (c) 2019 Tung Nguyen
2
-
3
- MIT License
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining
6
- a copy of this software and associated documentation files (the
7
- "Software"), to deal in the Software without restriction, including
8
- without limitation the rights to use, copy, modify, merge, publish,
9
- distribute, sublicense, and/or sell copies of the Software, and to
10
- permit persons to whom the Software is furnished to do so, subject to
11
- the following conditions:
12
-
13
- The above copyright notice and this permission notice shall be
14
- included in all copies or substantial portions of the Software.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # s3-secure
1
+ # s3-secure tool
2
2
 
3
3
  [![Gem Version](https://badge.fury.io/rb/s3-secure.png)](http://badge.fury.io/rb/s3-secure)
4
4
 
@@ -6,8 +6,15 @@
6
6
 
7
7
  The s3-secure tool can be used to harden your s3 bucket security posture. The tool is useful if you have a lot of buckets to update. It supports:
8
8
 
9
- * enabling encryption
10
- * adding an enforce ssl bucket policy
9
+ * access logs: enabling access logs
10
+ * encryption: enabling encryption
11
+ * ssl bucket policy: adding an enforce ssl bucket policy
12
+ * versioning: enabling bucket versioning
13
+
14
+ ## BoltOps Pro Related Blueprints
15
+
16
+ * [S3 Secure](https://github.com/boltopspro-docs/s3-secure): Continuously Auto-Remediates New Buckets.
17
+ * [Security Controls](https://github.com/boltopspro-docs/security-controls): Continuously applies the s3-secure remedations as well as other remeidations. IE: Security Groups, SNS topics, etc.
11
18
 
12
19
  ## Usage
13
20
 
@@ -18,6 +25,13 @@ Summary of encryption commands:
18
25
  s3-secure encryption enable BUCKET
19
26
  s3-secure encryption disable BUCKET
20
27
 
28
+ Summary of lifecycle commands:
29
+
30
+ s3-secure lifecycle list
31
+ s3-secure lifecycle show BUCKET
32
+ s3-secure lifecycle add BUCKET
33
+ s3-secure lifecycle remove BUCKET
34
+
21
35
  Summary of policy commands:
22
36
 
23
37
  s3-secure policy list
@@ -25,7 +39,22 @@ Summary of policy commands:
25
39
  s3-secure policy enforce_ssl BUCKET
26
40
  s3-secure policy unforce_ssl BUCKET
27
41
 
28
- ## Examples with Output
42
+ Summary of versioning commands:
43
+
44
+ s3-secure versioning list
45
+ s3-secure versioning show BUCKET
46
+ s3-secure versioning enable BUCKET
47
+ s3-secure versioning disable BUCKET
48
+
49
+ ## Remediate All
50
+
51
+ To apply all the remeidations:
52
+
53
+ s3-secure remediate_all BUCKET
54
+
55
+ For finer-control, run each subcommand instead.
56
+
57
+ ## Some Examples with Output
29
58
 
30
59
  Example of `s3-secure encryption enable`:
31
60
 
@@ -116,8 +145,12 @@ For more help:
116
145
  s3-secure -h
117
146
  s3-secure encryption -h
118
147
  s3-secure encryption enable -h
148
+ s3-secure lifecycle -h
149
+ s3-secure lifecycle add -h
119
150
  s3-secure policy -h
120
151
  s3-secure policy unforce_ssl -h
152
+ s3-secure versioning -h
153
+ s3-secure versioning enable -h
121
154
 
122
155
  ## Batch Commands
123
156
 
@@ -128,7 +161,7 @@ There are some supported batch commands:
128
161
  s3-secure batch policy enforce_ssl FILE.txt
129
162
  s3-secure batch policy unforce_ssl FILE.txt
130
163
 
131
- The format of FILE.txt is a list of bucket names separated by newlines. Example:
164
+ The format of `FILE.txt` is a list of bucket names separated by newlines. Example:
132
165
 
133
166
  buckets.txt:
134
167
 
@@ -137,14 +170,6 @@ buckets.txt:
137
170
 
138
171
  ## Installation
139
172
 
140
- Install with the `gem` command:
173
+ Install with:
141
174
 
142
175
  gem install s3-secure
143
-
144
- ## Contributing
145
-
146
- 1. Fork it
147
- 2. Create your feature branch (`git checkout -b my-new-feature`)
148
- 3. Commit your changes (`git commit -am "Add some feature"`)
149
- 4. Push to the branch (`git push origin my-new-feature`)
150
- 5. Create new Pull Request
@@ -0,0 +1,4 @@
1
+ module S3Secure::AccessLogs
2
+ class Base < S3Secure::CLI::Base
3
+ end
4
+ end
@@ -0,0 +1,37 @@
1
+ module S3Secure::AccessLogs
2
+ class Disable < Base
3
+ def run
4
+ @show = Show.new(bucket: @bucket)
5
+
6
+ remove_access_logging
7
+ remove_bucket_acl
8
+ end
9
+
10
+ def remove_access_logging
11
+ unless @show.logging_enabled?
12
+ say "Bucket #{@bucket} is not configured with access logging. So nothing to remove."
13
+ return
14
+ end
15
+
16
+ s3.put_bucket_logging(
17
+ bucket: @bucket, # source
18
+ bucket_logging_status: {}, # empty hash to remove
19
+ )
20
+ say "Bucket #{@bucket} access logging removed"
21
+ end
22
+
23
+ def remove_bucket_acl
24
+ unless @show.acl_enabled?
25
+ say "Bucket #{@bucket} is not configured the log delivery ACL. So nothing to remove."
26
+ return
27
+ end
28
+
29
+ access_control_policy = @show.access_control_policy_without_log_delivery_permissions
30
+ s3.put_bucket_acl(
31
+ bucket: @bucket,
32
+ access_control_policy: access_control_policy,
33
+ )
34
+ say "Bucket #{@bucket} ACL Log Delivery removed"
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,41 @@
1
+ module S3Secure::AccessLogs
2
+ class Enable < Base
3
+ def run
4
+ @show = Show.new(bucket: @bucket)
5
+ add_bucket_acl
6
+ enable_access_logging
7
+ end
8
+
9
+ # Bucket ACL applies on the target bucket only
10
+ def add_bucket_acl
11
+ if @show.acl_enabled?
12
+ say "Bucket acl already has log delivery ACL"
13
+ return
14
+ end
15
+
16
+ s3.put_bucket_acl(
17
+ bucket: @bucket,
18
+ access_control_policy: @show.access_control_policy_with_log_delivery_permissions,
19
+ )
20
+ say "Added to bucket acl that grants log delivery"
21
+ end
22
+
23
+ def enable_access_logging
24
+ if @show.logging_enabled?
25
+ say "Bucket access logging already enabled"
26
+ return
27
+ end
28
+
29
+ s3.put_bucket_logging(
30
+ bucket: @bucket, # source
31
+ bucket_logging_status: {
32
+ logging_enabled: {
33
+ target_bucket: @show.target_bucket,
34
+ target_prefix: @show.target_prefix,
35
+ },
36
+ },
37
+ )
38
+ say "Enabled access logging on the source bucket #{@bucket} to be delivered to the target bucket #{@show.target_bucket}"
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,25 @@
1
+ module S3Secure::AccessLogs
2
+ class List < Base
3
+ def run
4
+ presenter = CliFormat::Presenter.new(@options)
5
+ presenter.header = ["Bucket", "Access Logs?"]
6
+
7
+ buckets.each do |bucket|
8
+ $stderr.puts "Getting access log setting for bucket #{bucket.color(:green)}"
9
+ show = Show.new(bucket: bucket)
10
+
11
+ enabled = show.logging_enabled?
12
+ row = [bucket, enabled]
13
+ if @options[:enabled].nil?
14
+ presenter.rows << row # always show policy
15
+ elsif @options[:enabled]
16
+ presenter.rows << row if enabled # only show if bucket has some encryption rules
17
+ else
18
+ presenter.rows << row unless enabled # only show if bucket doesnt have any encryption rules
19
+ end
20
+ end
21
+
22
+ presenter.show
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,89 @@
1
+ module S3Secure::AccessLogs
2
+ class Show < Base
3
+ def run
4
+ say "Bucket ACL:"
5
+ pp bucket_acl_grants
6
+ say "Bucket Logging:"
7
+ pp bucket_logging
8
+ end
9
+
10
+ def bucket_logging
11
+ # Tricky here, need to swtich the s3 client in case target_bucket is in another region
12
+ with_regional_s3(target_bucket) do
13
+ s3.get_bucket_logging(bucket: target_bucket).to_h
14
+ end
15
+ end
16
+ memoize :bucket_logging
17
+
18
+ def bucket_acl
19
+ # Tricky here, need to swtich the s3 client in case target_bucket is in another region
20
+ with_regional_s3(target_bucket) do
21
+ s3.get_bucket_acl(bucket: target_bucket)
22
+ end
23
+ end
24
+ memoize :bucket_acl
25
+
26
+ def bucket_acl_grants
27
+ bucket_acl.grants.map(&:to_h)
28
+ end
29
+
30
+ def enabled?
31
+ acl_enabled? && logging_enabled?
32
+ end
33
+
34
+ def acl_enabled?
35
+ grants = bucket_acl_grants & log_delivery_access_grants
36
+ !grants.empty?
37
+ end
38
+
39
+ def logging_enabled?
40
+ !bucket_logging.empty?
41
+ end
42
+
43
+ def log_delivery_access_grants
44
+ [
45
+ {
46
+ grantee: {type: "Group", uri: "http://acs.amazonaws.com/groups/s3/LogDelivery"},
47
+ permission: "WRITE"
48
+ },{
49
+ grantee: {type: "Group", uri: "http://acs.amazonaws.com/groups/s3/LogDelivery"},
50
+ permission: "READ_ACP"
51
+ }
52
+ ]
53
+ end
54
+
55
+ def access_control_policy_with_log_delivery_permissions
56
+ grants = bucket_acl_grants + log_delivery_access_grants
57
+ { grants: grants, owner: owner }
58
+ end
59
+
60
+ def access_control_policy_without_log_delivery_permissions
61
+ grants = bucket_acl_grants - log_delivery_access_grants
62
+ { grants: grants, owner: owner }
63
+ end
64
+
65
+ def owner
66
+ {
67
+ display_name: bucket_acl.owner.display_name,
68
+ id: bucket_acl.owner.id,
69
+ }
70
+ end
71
+
72
+ def target_bucket
73
+ @options[:target_bucket] || @bucket
74
+ end
75
+
76
+ def target_prefix
77
+ prefix = @options[:target_prefix] || "access-logs"
78
+ prefix += "/" unless prefix.ends_with?("/")
79
+ prefix
80
+ end
81
+
82
+ def with_regional_s3(bucket)
83
+ current_bucket, @bucket = @bucket, bucket
84
+ result = yield
85
+ @bucket = current_bucket
86
+ result
87
+ end
88
+ end
89
+ end
@@ -0,0 +1,61 @@
1
+ module S3Secure::AwsServices
2
+ module S3
3
+ extend Memoist
4
+
5
+ @@s3_clients = {} # holds cached s3 regional clients cache
6
+ def s3
7
+ check_bucket!
8
+ @@s3_clients[@bucket] ||= new_s3_regional_client
9
+ end
10
+
11
+ def s3_regional_client(bucket)
12
+ temp = @bucket
13
+ @bucket = bucket
14
+ @@s3_clients[bucket] ||= new_s3_regional_client
15
+ @bucket = temp
16
+ end
17
+
18
+ def new_s3_regional_client
19
+ options = {}
20
+ options[:endpoint] = "https://s3.#{region}.amazonaws.com"
21
+ options[:region] = region
22
+ Aws::S3::Client.new(options)
23
+ rescue Aws::STS::Errors::RegionDisabledException
24
+ puts "ERROR: Fail to establish client connection to region #{region}".color(:red)
25
+ raise
26
+ end
27
+
28
+ # Generic s3 client. Will be configured to whatever region user has locally configured in ~/.aws/config
29
+ # Used to call get_bucket_location to get each specific bucket's location.
30
+ # Generally use the s3_regional_client instead of this.
31
+ def s3_client
32
+ Aws::S3::Client.new
33
+ end
34
+ memoize :s3_client
35
+
36
+ def check_bucket!
37
+ # IMPORANT: The class that includes this module must set @bucket before using the s3 method.
38
+ unless @bucket
39
+ raise "@bucket #{@bucket.inspect} is not set. The class must set @bucket before using the any client method."
40
+ end
41
+ region_map # triggers building region map for specific @bucket
42
+ end
43
+
44
+ @@region_map = {} # bucket to region map cache
45
+ def region_map
46
+ region = @@region_map[@bucket]
47
+ return @@region_map if region # return cache
48
+
49
+ # build cache
50
+ resp = s3_client.get_bucket_location(bucket: @bucket)
51
+ region = resp.location_constraint
52
+ region = 'us-east-1' if region.empty? # "" means us-east-1
53
+ @@region_map[@bucket] = region
54
+ @@region_map
55
+ end
56
+
57
+ def region
58
+ region_map[@bucket]
59
+ end
60
+ end
61
+ end
@@ -3,37 +3,11 @@ require "aws-sdk-s3"
3
3
  module S3Secure
4
4
  module AwsServices
5
5
  extend Memoist
6
+ include S3
6
7
 
7
- @@buckets = {} # holds bucket => region map
8
- def s3_regional_client(bucket)
9
- region = @@buckets[bucket]
10
-
11
- unless region
12
- resp = s3_client.get_bucket_location(bucket: bucket)
13
- region = resp.location_constraint
14
- region = 'us-east-1' if region.empty? # "" means us-east-1
15
- end
16
-
17
- new_s3_regional_client(region)
18
- end
19
-
20
- def new_s3_regional_client(region=nil)
21
- options = {}
22
- options[:endpoint] = "https://s3.#{region}.amazonaws.com" if region
23
- options[:region] = region if region
24
- Aws::S3::Client.new(options)
25
- rescue Aws::STS::Errors::RegionDisabledException
26
- puts "ERROR: Fail to establish client connection to region #{region}".color(:red)
27
- raise
28
- end
29
- memoize :new_s3_regional_client
30
-
31
- # Generic s3 client. Will be configured to whatever region user has locally configured in ~/.aws/config
32
- # Used to call get_bucket_location to get each specific bucket's location.
33
- # Generally use the s3_regional_client instead of this.
34
- def s3_client
35
- Aws::S3::Client.new
8
+ def sts
9
+ Aws::STS::Client.new
36
10
  end
37
- memoize :s3_client
11
+ memoize :sts
38
12
  end
39
13
  end