s3-secure 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f990c19df8d1e76dddcdba7b3b3bde118835f002cad7fa83d88174ce73f5ec94
-  data.tar.gz: e6fe39ed79c6e81962ae003d4b4591d7baa0ab886538a0ee77fa0e7c3a43c2d1
+  metadata.gz: 6e1f48e9f8af3b66318cc9bbb69c7689e6973f10979e0adc5d2274fa0e3fc1a6
+  data.tar.gz: 72c7e5845cdf8438a785bc5310ed25ce82b7c73d29c2891430492d817dd9159f
 SHA512:
-  metadata.gz: a681ba106ada2376c3a9683b6b412eb6c6df5de7f7ce9d550b11b700d248be850fda0e7c71c976feb3040854d33681e8d4c51c7aa32883d9ab5fe73d16ed0afb
-  data.tar.gz: 539bc7cb06025cca7c21fa88fd9a26b68b62aa773723f0eca618d3b24c4e4d3a983c5bbd61f7dab6c242b08ad56074805cb4bcced462195d3d3bf97cc5fee3ec
+  metadata.gz: 5cf2fe5bf3f6e8d889eb9fe3bf912782e819e65d423bf2ef12b63bb480b6ac6d6849d061c87cc46988e1fb3f9c5be71ee293c59a73566cd70e976aec39d84f0f
+  data.tar.gz: 6e41d083dd57a83be7b33a23b49c430f63803403ce8ba97a7fd5b25ca764d38a99c16a0dc2d9d6ff054a00aebb39bca0b1cc3ecbb9eb5e796bb19a57bb819032

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.5.0]
+- add commands: access_logs, lifecycle, versioning, remediate_all
+- s3 client is smarter and switches regions on a per-bucket basis
+
 ## [0.4.2]
 - improve error message for Aws::STS::Errors::RegionDisabledException error
 

data/LICENSE.txt

@@ -1,22 +1,201 @@
-Copyright (c) 2019 Tung Nguyen
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,13 +1,19 @@
-# s3-secure
-
-[![Gem Version](https://badge.fury.io/rb/s3-secure.png)](http://badge.fury.io/rb/s3-secure)
+# s3-secure tool
 
+[![Gem Version](https://badge.fury.io/rb/s3-secure.png)](http://badge.fury.io/rb/s3-secure)]
 [![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
 
 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:
 
-* enabling encryption
-* adding an enforce ssl bucket policy
+* access logs: enabling access logs
+* encryption: enabling encryption
+* ssl bucket policy: adding an enforce ssl bucket policy
+* versioning: enabling bucket versioning
+
+## BoltOps Pro Related Blueprints
+
+* [S3 Secure](https://github.com/boltopspro-docs/s3-secure): Continuously Auto-Remediates New Buckets.
+* [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.
 
 ## Usage
 
@@ -18,6 +24,13 @@ Summary of encryption commands:
     s3-secure encryption enable BUCKET
     s3-secure encryption disable BUCKET
 
+Summary of lifecycle commands:
+
+    s3-secure lifecycle list
+    s3-secure lifecycle show BUCKET
+    s3-secure lifecycle add BUCKET
+    s3-secure lifecycle remove BUCKET
+
 Summary of policy commands:
 
     s3-secure policy list
@@ -25,7 +38,22 @@ Summary of policy commands:
     s3-secure policy enforce_ssl BUCKET
     s3-secure policy unforce_ssl BUCKET
 
-## Examples with Output
+Summary of versioning commands:
+
+    s3-secure versioning list
+    s3-secure versioning show BUCKET
+    s3-secure versioning enable BUCKET
+    s3-secure versioning disable BUCKET
+
+## Remediate All
+
+To apply all the remeidations:
+
+    s3-secure remediate_all BUCKET
+
+For finer-control, run each subcommand instead.
+
+## Some Examples with Output
 
 Example of `s3-secure encryption enable`:
 
@@ -116,8 +144,12 @@ For more help:
     s3-secure -h
     s3-secure encryption -h
     s3-secure encryption enable -h
+    s3-secure lifecycle -h
+    s3-secure lifecycle add -h
     s3-secure policy -h
     s3-secure policy unforce_ssl -h
+    s3-secure versioning -h
+    s3-secure versioning enable -h
 
 ## Batch Commands
 
@@ -128,7 +160,7 @@ There are some supported batch commands:
     s3-secure batch policy enforce_ssl FILE.txt
     s3-secure batch policy unforce_ssl FILE.txt
 
-The format of FILE.txt is a list of bucket names separated by newlines.  Example:
+The format of `FILE.txt` is a list of bucket names separated by newlines.  Example:
 
 buckets.txt:
 
@@ -137,14 +169,6 @@ buckets.txt:
 
 ## Installation
 
-Install with the `gem` command:
-
-    gem install s3-secure
-
-## Contributing
+Install with:
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am "Add some feature"`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+    gem install s3-secure

data/lib/s3_secure.rb

@@ -1,10 +1,11 @@
 $:.unshift(File.expand_path("../", __FILE__))
+require "active_support/core_ext/module" # for delegate
+require "active_support/core_ext/string"
+require "cli_format"
 require "json"
 require "memoist"
 require "rainbow/ext/string"
 require "s3_secure/version"
-require "active_support/core_ext/module" # for delegate
-require "active_support/core_ext/string"
 
 require "s3_secure/autoloader"
 S3Secure::Autoloader.setup

data/lib/s3_secure/access_logs.rb

@@ -0,0 +1,30 @@
+module S3Secure
+  class AccessLogs < Command
+    desc "list", "List bucket access_logs setting"
+    long_desc Help.text("access_logs/list")
+    option :format, desc: "Format options: #{CliFormat.formats.join(', ')}"
+    option :access_logs, type: :boolean, desc: "Filter for access_logs: all, true, false"
+    def list
+      List.new(options).run
+    end
+
+    desc "show BUCKET", "show bucket access_logs"
+    long_desc Help.text("access_logs/show")
+    def show(bucket)
+      Show.new(options.merge(bucket: bucket)).run
+    end
+
+    desc "enable BUCKET", "enable bucket access_logs"
+    long_desc Help.text("access_logs/enable")
+    option :target_bucket, desc: "Target s3 bucket"
+    def enable(bucket)
+      Enable.new(options.merge(bucket: bucket)).run
+    end
+
+    desc "disable BUCKET", "disable bucket access_logs"
+    long_desc Help.text("access_logs/disable")
+    def disable(bucket)
+      Disable.new(options.merge(bucket: bucket)).run
+    end
+  end
+end

data/lib/s3_secure/access_logs/base.rb

@@ -0,0 +1,4 @@
+class S3Secure::AccessLogs
+  class Base < S3Secure::AbstractBase
+  end
+end

data/lib/s3_secure/access_logs/disable.rb

@@ -0,0 +1,37 @@
+class S3Secure::AccessLogs
+  class Disable < Base
+    def run
+      @show = Show.new(bucket: @bucket)
+
+      remove_access_logging
+      remove_bucket_acl
+    end
+
+    def remove_access_logging
+      unless @show.logging_enabled?
+        puts "Bucket #{@bucket} is not configured with access logging. So nothing to remove."
+        return
+      end
+
+      s3.put_bucket_logging(
+        bucket: @bucket, # source
+        bucket_logging_status: {}, # empty hash to remove
+      )
+      puts "Bucket #{@bucket} access logging removed"
+    end
+
+    def remove_bucket_acl
+      unless @show.acl_enabled?
+        puts "Bucket #{@bucket} is not configured the log delivery ACL. So nothing to remove."
+        return
+      end
+
+      access_control_policy = @show.access_control_policy_without_log_delivery_permissions
+      s3.put_bucket_acl(
+        bucket: @bucket,
+        access_control_policy: access_control_policy,
+      )
+      puts "Bucket #{@bucket} ACL Log Delivery removed"
+    end
+  end
+end

data/lib/s3_secure/access_logs/enable.rb

@@ -0,0 +1,41 @@
+class S3Secure::AccessLogs
+  class Enable < Base
+    def run
+      @show = Show.new(bucket: @bucket)
+      add_bucket_acl
+      enable_access_logging
+    end
+
+    # Bucket ACL applies on the target bucket only
+    def add_bucket_acl
+      if @show.acl_enabled?
+        puts "Bucket acl already has log delivery ACL"
+        return
+      end
+
+      s3.put_bucket_acl(
+        bucket: @bucket,
+        access_control_policy: @show.access_control_policy_with_log_delivery_permissions,
+      )
+      puts "Added to bucket acl that grants log delivery"
+    end
+
+    def enable_access_logging
+      if @show.logging_enabled?
+        puts "Bucket access logging already enabled"
+        return
+      end
+
+      s3.put_bucket_logging(
+        bucket: @bucket, # source
+        bucket_logging_status: {
+          logging_enabled: {
+            target_bucket: @show.target_bucket,
+            target_prefix: @show.target_prefix,
+          },
+        },
+      )
+      puts "Enabled access logging on the source bucket #{@bucket} to be delivered to the target bucket #{@show.target_bucket}"
+    end
+  end
+end