terraspace_plugin_aws 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5637326fc002e5732dc1f88390505ad9287ce54926e24646ae6fac4070d851f
-  data.tar.gz: 9bd59a232bed2d678dbb6d04c2043c91a0312f8f2385623d5eb7c27416e507cc
+  metadata.gz: 855a5c7166b24f8881c2d735edd0c252cefd6d0175a9a0f1156090ca08a11e5d
+  data.tar.gz: be95c5a77b116c62dac152ec6f8ec9cfb5b68ad372475373823508472bca3566
 SHA512:
-  metadata.gz: 5415e06cdac40d7b415474bcf4fcce6f063369e3e3a7354a9256ecb1adaba51dc23b8d1d8c56c53be90c21d5eb8fef4fddce951784eb193dc974829b2a825671
-  data.tar.gz: f6b29f9a92920e925a4a7c85817f8d03ad2e94899a51849a1e88cb523d81b77440fec922907f12da94955f30807817fb92bca20000bc0f4ec4efcdaa69f61a02
+  metadata.gz: 12ff9c7c0fcc8b10d82385855b5a5724392729ef79254cad41fce51b0ddab0d3ec17a927b08da1e071adde23e1c8e1289e48d32f7948753675b6d0fd680596c7
+  data.tar.gz: 717dffbad397bb5fd3953739060e5e2ad7bb6d90f842c13ab6f0fb00f5f3cf1b82357ed401b118a2ddde584c9dd6ccdda0712cce493fd2ec0be48433b35f52ab

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [0.3.1] - 2021-12-14
+- [#8](https://github.com/boltops-tools/terraspace_plugin_aws/pull/8) use region configured in the backend.tf for the s3 client
+
+## [0.3.0] - 2020-11-15
+- [#5](https://github.com/boltops-tools/terraspace_plugin_aws/pull/5) helper and secrets support
+- aws_secret and aws_ssm helpers
+
+## [0.2.2]
+- #4 default access logging to false
+- set prefix to @folder for performance improvement
+
+## [0.2.1]
+- #3 quiet s3-secure messages
+
 ## [0.2.0]
 - #2 include layer interface, update template to expansion method
 

data/README.md

@@ -24,7 +24,7 @@ TerraspacePluginAws.configure do |config|
   config.s3.enforce_ssl = true
   config.s3.versioning = true
   config.s3.lifecycle = true
-  config.s3.access_logging = true
+  config.s3.access_logging = false # false by default
   config.s3.secure_existing = false # run the security controls on existing buckets. by default, only run on newly created bucket the first time
 
   config.dynamodb.encryption = true

data/lib/templates/hcl/project/config/terraform/backend.tf.tt

@@ -1,7 +1,7 @@
 terraform {
   backend "s3" {
-    bucket         = "<%%= expansion('terraform-state-:ACCOUNT-:REGION-:ENV') %>"     # expanded by terraspace IE: terraform-state-112233445566-us-west-2-dev
-    key            = "<%%= expansion(':REGION/:ENV/:BUILD_DIR/terraform.tfstate') %>" # expanded by terraspace IE: us-west-2/dev/modules/vm/terraform.tfstate
+    bucket         = "<%%= expansion('terraform-state-:ACCOUNT-:REGION-:ENV') %>"
+    key            = "<%%= expansion(':REGION/:ENV/:BUILD_DIR/terraform.tfstate') %>"
     region         = "<%%= expansion(':REGION') %>"
     encrypt        = true
     dynamodb_table = "terraform_locks"

data/lib/terraspace_plugin_aws/autoloader.rb

@@ -4,7 +4,7 @@ module TerraspacePluginAws
   class Autoloader
     class Inflector < Zeitwerk::Inflector
       def camelize(basename, _abspath)
-        map = { cli: "CLI", version: "VERSION" }
+        map = { cli: "CLI", ssm: "SSM", version: "VERSION" }
         map[basename.to_sym] || super
       end
     end

data/lib/terraspace_plugin_aws/clients.rb

@@ -1,18 +1,39 @@
 require "aws-sdk-dynamodb"
 require "aws-sdk-s3"
+require "aws-sdk-secretsmanager"
+require "aws-sdk-ssm"
 
 module TerraspacePluginAws
   module Clients
     extend Memoist
 
     def s3
-      Aws::S3::Client.new
+      Aws::S3::Client.new(client_options)
     end
     memoize :s3
 
+    def secretsmanager
+      Aws::SecretsManager::Client.new(client_options)
+    end
+    memoize :secretsmanager
+
+    def ssm
+      Aws::SSM::Client.new(client_options)
+    end
+    memoize :ssm
+
     def dynamodb
-      Aws::DynamoDB::Client.new
+      Aws::DynamoDB::Client.new(client_options)
     end
     memoize :dynamodb
+
+    # Typically inferred from AWS_REGION unless set in the backend.tf
+    def client_options
+      if @info['region']
+        {region: @info['region']}
+      else
+        {}
+      end
+    end
   end
 end

data/lib/terraspace_plugin_aws/interfaces/backend/base.rb

@@ -3,13 +3,10 @@ require "s3-secure"
 class TerraspacePluginAws::Interfaces::Backend
   class Base
     include TerraspacePluginAws::Clients
+    include TerraspacePluginAws::Logging
 
     def initialize(info)
       @info = info
     end
-
-    def logger
-      Terraspace.logger
-    end
   end
 end

data/lib/terraspace_plugin_aws/interfaces/backend/bucket/secure.rb

@@ -4,12 +4,12 @@ class TerraspacePluginAws::Interfaces::Backend::Bucket
   module Secure
     def secure(bucket)
       c = TerraspacePluginAws::Interfaces::Config.instance.config.s3
-
-      S3Secure::Encryption::Enable.new(bucket: bucket).run if c.encryption
-      S3Secure::Policy::Enforce.new(bucket: bucket, sid: "ForceSSLOnlyAccess").run if c.enforce_ssl
-      S3Secure::Versioning::Enable.new(bucket: bucket).run if c.versioning
-      S3Secure::Lifecycle::Add.new(bucket: bucket).run if c.lifecycle
-      S3Secure::AccessLogs::Enable.new(bucket: bucket).run if c.access_logging
+      options = {bucket: bucket, quiet: true}
+      S3Secure::Encryption::Enable.new(options).run if c.encryption
+      S3Secure::Policy::Enforce.new(options.merge(sid: "ForceSSLOnlyAccess")).run if c.enforce_ssl
+      S3Secure::Versioning::Enable.new(options).run if c.versioning
+      S3Secure::Lifecycle::Add.new(options).run if c.lifecycle
+      S3Secure::AccessLogs::Enable.new(options).run if c.access_logging
     end
   end
 end

data/lib/terraspace_plugin_aws/interfaces/config.rb

@@ -20,7 +20,7 @@ module TerraspacePluginAws::Interfaces
       c.s3.enforce_ssl = true
       c.s3.versioning = true
       c.s3.lifecycle = true
-      c.s3.access_logging = true
+      c.s3.access_logging = false
       c.s3.secure_existing = false # run the security controls on existing buckets. by default, only run on newly created bucket the first time
 
       c.dynamodb = ActiveSupport::OrderedOptions.new

data/lib/terraspace_plugin_aws/interfaces/helper/secret.rb

@@ -0,0 +1,18 @@
+module TerraspacePluginAws::Interfaces::Helper
+  class Secret < SecretBase
+    def fetch(secret_id)
+      value = fetch_value(secret_id)
+      value = Base64.strict_encode64(value).strip if @base64
+      value
+    end
+
+    def fetch_value(secret_id)
+      secret_value = secretsmanager.get_secret_value(secret_id: secret_id)
+      secret_value.secret_string
+    rescue Aws::SecretsManager::Errors::ResourceNotFoundException => e
+      logger.info "WARN: secret_id #{secret_id} not found".color(:yellow)
+      logger.info e.message
+      "NOT FOUND #{secret_id}" # simple string so Kubernetes YAML is valid
+    end
+  end
+end

data/lib/terraspace_plugin_aws/interfaces/helper/secret_base.rb

@@ -0,0 +1,13 @@
+require "base64"
+
+module TerraspacePluginAws::Interfaces::Helper
+  class SecretBase
+    include TerraspacePluginAws::Clients
+    include TerraspacePluginAws::Logging
+
+    def initialize(options={})
+      @options = options
+      @base64 = options[:base64]
+    end
+  end
+end

data/lib/terraspace_plugin_aws/interfaces/helper/ssm.rb

@@ -0,0 +1,18 @@
+module TerraspacePluginAws::Interfaces::Helper
+  class SSM < SecretBase
+    def fetch(name)
+      value = fetch_value(name)
+      value = Base64.strict_encode64(value).strip if @base64
+      value
+    end
+
+    def fetch_value(name)
+      resp = ssm.get_parameter(name: name, with_decryption: true)
+      resp.parameter.value
+    rescue Aws::SSM::Errors::ParameterNotFound => e
+      logger.info "WARN: name #{name} not found".color(:yellow)
+      logger.info e.message
+      "NOT FOUND #{name}" # simple string so tfvars valid
+    end
+  end
+end

data/lib/terraspace_plugin_aws/interfaces/helper.rb

@@ -0,0 +1,15 @@
+module TerraspacePluginAws::Interfaces
+  module Helper
+    include Terraspace::Plugin::Helper::Interface
+
+    def aws_secret(name, options={})
+      Secret.new(options).fetch(name)
+    end
+    cache_helper :aws_secret
+
+    def aws_ssm(name, options={})
+      SSM.new(options).fetch(name)
+    end
+    cache_helper :aws_ssm
+  end
+end

data/lib/terraspace_plugin_aws/interfaces/summary.rb

@@ -5,7 +5,7 @@ module TerraspacePluginAws::Interfaces
 
     # interface method
     def download
-      resp = s3.list_objects(bucket: @bucket)
+      resp = s3.list_objects(bucket: @bucket, prefix: @folder)
       resp.contents.each do |content|
         local_path = "#{@dest}/#{content.key}"
         FileUtils.mkdir_p(File.dirname(local_path))

data/lib/terraspace_plugin_aws/logging.rb

@@ -0,0 +1,7 @@
+module TerraspacePluginAws
+  module Logging
+    def logger
+      Terraspace.logger
+    end
+  end
+end

data/lib/terraspace_plugin_aws/version.rb

@@ -1,3 +1,3 @@
 module TerraspacePluginAws
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/terraspace_plugin_aws.rb

@@ -22,12 +22,22 @@ module TerraspacePluginAws
     Interfaces::Config.instance.config
   end
 
+  @@logger = nil
+  def logger
+    @@logger ||= Terraspace.logger
+  end
+
+  def logger=(v)
+    @@logger = v
+  end
+
   extend self
 end
 
 Terraspace::Plugin.register("aws",
   backend: "s3",
   config_class: TerraspacePluginAws::Interfaces::Config,
-  layer_class: TerraspacePluginAws::Interfaces::Layer, # used for layering
+  helper_class: TerraspacePluginAws::Interfaces::Helper,
+  layer_class: TerraspacePluginAws::Interfaces::Layer,
   root: File.dirname(__dir__),
 )

data/terraspace_plugin_aws.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "aws-sdk-dynamodb"
   spec.add_dependency "aws-sdk-s3"
+  spec.add_dependency "aws-sdk-secretsmanager"
+  spec.add_dependency "aws-sdk-ssm"
   spec.add_dependency "aws_data"
   spec.add_dependency "memoist"
   spec.add_dependency "s3-secure"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace_plugin_aws
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-secretsmanager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws_data
   requirement: !ruby/object:Gem::Requirement
@@ -149,8 +177,13 @@ files:
 - lib/terraspace_plugin_aws/interfaces/decorator/aws_security_group.rb
 - lib/terraspace_plugin_aws/interfaces/decorator/base.rb
 - lib/terraspace_plugin_aws/interfaces/expander.rb
+- lib/terraspace_plugin_aws/interfaces/helper.rb
+- lib/terraspace_plugin_aws/interfaces/helper/secret.rb
+- lib/terraspace_plugin_aws/interfaces/helper/secret_base.rb
+- lib/terraspace_plugin_aws/interfaces/helper/ssm.rb
 - lib/terraspace_plugin_aws/interfaces/layer.rb
 - lib/terraspace_plugin_aws/interfaces/summary.rb
+- lib/terraspace_plugin_aws/logging.rb
 - lib/terraspace_plugin_aws/version.rb
 - terraspace_plugin_aws.gemspec
 homepage: https://github.com/boltops-tools/terraspace_plugin_aws
@@ -173,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Terraspace AWS Plugin