inspec 2.1.0 → 2.1.10

data/lib/resources/auditd_conf.rb

@@ -1,55 +1,46 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-
-require 'utils/simpleconfig'
-
-module Inspec::Resources
-  class AuditDaemonConf < Inspec.resource(1)
-    name 'auditd_conf'
-    supports platform: 'unix'
-    desc "Use the auditd_conf InSpec audit resource to test the configuration settings for the audit daemon. This file is typically located under /etc/audit/auditd.conf' on UNIX and Linux platforms."
-    example "
-      describe auditd_conf do
-        its('space_left_action') { should eq 'email' }
-      end
-    "
-
-    def initialize(path = nil)
-      @conf_path = path || '/etc/audit/auditd.conf'
-    end
-
-    def method_missing(name)
-      read_params[name.to_s]
-    end
-
-    def to_s
-      'Audit Daemon Config'
-    end
-
-    private
-
-    def read_params
-      return @params if defined?(@params)
-
-      # read the file
-      file = inspec.file(@conf_path)
-      if !file.file?
-        skip_resource "Can't find file '#{@conf_path}'"
-        return @params = {}
-      end
-
-      content = file.content
-      if content.empty? && !file.empty?
-        skip_resource "Can't read file '#{@conf_path}'"
-        return @params = {}
-      end
-
-      # parse the file
-      conf = SimpleConfig.new(
-        content,
-        multiple_values: false,
-      )
-      @params = conf.params
-    end
-  end
-end
+# encoding: utf-8
+# copyright: 2015, Vulcano Security GmbH
+
+require 'utils/simpleconfig'
+require 'utils/file_reader'
+
+module Inspec::Resources
+  class AuditDaemonConf < Inspec.resource(1)
+    name 'auditd_conf'
+    supports platform: 'unix'
+    desc "Use the auditd_conf InSpec audit resource to test the configuration settings for the audit daemon. This file is typically located under /etc/audit/auditd.conf' on UNIX and Linux platforms."
+    example "
+      describe auditd_conf do
+        its('space_left_action') { should eq 'email' }
+      end
+    "
+
+    include FileReader
+
+    def initialize(path = nil)
+      @conf_path = path || '/etc/audit/auditd.conf'
+      @content = read_file_content(@conf_path)
+    end
+
+    def method_missing(name)
+      read_params[name.to_s]
+    end
+
+    def to_s
+      'Audit Daemon Config'
+    end
+
+    private
+
+    def read_params
+      return @params if defined?(@params)
+
+      # parse the file
+      conf = SimpleConfig.new(
+        @content,
+        multiple_values: false,
+      )
+      @params = conf.params
+    end
+  end
+end

data/lib/resources/aws/aws_cloudtrail_trail.rb

@@ -1,77 +1,77 @@
-class AwsCloudTrailTrail < Inspec.resource(1)
-  name 'aws_cloudtrail_trail'
-  desc 'Verifies settings for an individual AWS CloudTrail Trail'
-  example "
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should exist }
-    end
-  "
-
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-  attr_reader :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :home_region,
-              :kms_key_id, :s3_bucket_name, :trail_arn
-
-  def to_s
-    "CloudTrail #{@trail_name}"
-  end
-
-  def multi_region_trail?
-    @is_multi_region_trail
-  end
-
-  def log_file_validation_enabled?
-    @log_file_validation_enabled
-  end
-
-  def encrypted?
-    !kms_key_id.nil?
-  end
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:trail_name],
-      allowed_scalar_name: :trail_name,
-      allowed_scalar_type: String,
-    )
-
-    if validated_params.empty?
-      raise ArgumentError, "You must provide the parameter 'trail_name' to aws_cloudtrail_trail."
-    end
-
-    validated_params
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-
-    query = { trail_name_list: [@trail_name] }
-    resp = backend.describe_trails(query)
-
-    @trail = resp.trail_list[0].to_h
-    @exists = !@trail.empty?
-    @s3_bucket_name = @trail[:s3_bucket_name]
-    @is_multi_region_trail = @trail[:is_multi_region_trail]
-    @trail_arn = @trail[:trail_arn]
-    @log_file_validation_enabled = @trail[:log_file_validation_enabled]
-    @cloud_watch_logs_role_arn = @trail[:cloud_watch_logs_role_arn]
-    @cloud_watch_logs_log_group_arn = @trail[:cloud_watch_logs_log_group_arn]
-    @kms_key_id = @trail[:kms_key_id]
-    @home_region = @trail[:home_region]
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      AwsCloudTrailTrail::BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::CloudTrail::Client
-
-      def describe_trails(query)
-        aws_service_client.describe_trails(query)
-      end
-    end
-  end
-end
+class AwsCloudTrailTrail < Inspec.resource(1)
+  name 'aws_cloudtrail_trail'
+  desc 'Verifies settings for an individual AWS CloudTrail Trail'
+  example "
+    describe aws_cloudtrail_trail('trail-name') do
+      it { should exist }
+    end
+  "
+
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+  attr_reader :cloud_watch_logs_log_group_arn, :cloud_watch_logs_role_arn, :home_region,
+              :kms_key_id, :s3_bucket_name, :trail_arn
+
+  def to_s
+    "CloudTrail #{@trail_name}"
+  end
+
+  def multi_region_trail?
+    @is_multi_region_trail
+  end
+
+  def log_file_validation_enabled?
+    @log_file_validation_enabled
+  end
+
+  def encrypted?
+    !kms_key_id.nil?
+  end
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:trail_name],
+      allowed_scalar_name: :trail_name,
+      allowed_scalar_type: String,
+    )
+
+    if validated_params.empty?
+      raise ArgumentError, "You must provide the parameter 'trail_name' to aws_cloudtrail_trail."
+    end
+
+    validated_params
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+
+    query = { trail_name_list: [@trail_name] }
+    resp = backend.describe_trails(query)
+
+    @trail = resp.trail_list[0].to_h
+    @exists = !@trail.empty?
+    @s3_bucket_name = @trail[:s3_bucket_name]
+    @is_multi_region_trail = @trail[:is_multi_region_trail]
+    @trail_arn = @trail[:trail_arn]
+    @log_file_validation_enabled = @trail[:log_file_validation_enabled]
+    @cloud_watch_logs_role_arn = @trail[:cloud_watch_logs_role_arn]
+    @cloud_watch_logs_log_group_arn = @trail[:cloud_watch_logs_log_group_arn]
+    @kms_key_id = @trail[:kms_key_id]
+    @home_region = @trail[:home_region]
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      AwsCloudTrailTrail::BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::CloudTrail::Client
+
+      def describe_trails(query)
+        aws_service_client.describe_trails(query)
+      end
+    end
+  end
+end

data/lib/resources/aws/aws_cloudtrail_trails.rb

@@ -1,47 +1,47 @@
-class AwsCloudTrailTrails < Inspec.resource(1)
-  name 'aws_cloudtrail_trails'
-  desc 'Verifies settings for AWS CloudTrail Trails in bulk'
-  example '
-    describe aws_cloudtrail_trails do
-      it { should exist }
-    end
-  '
-  supports platform: 'aws'
-
-  include AwsPluralResourceMixin
-
-  def validate_params(resource_params)
-    unless resource_params.empty?
-      raise ArgumentError, 'aws_cloudtrail_trails does not accept resource parameters.'
-    end
-    resource_params
-  end
-
-  # Underlying FilterTable implementation.
-  filter = FilterTable.create
-  filter.add_accessor(:entries)
-        .add(:exists?) { |x| !x.entries.empty? }
-        .add(:names, field: :name)
-        .add(:trail_arns, field: :trail_arn)
-  filter.connect(self, :table)
-
-  def to_s
-    'CloudTrail Trails'
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-    @table = backend.describe_trails({}).to_h[:trail_list]
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      AwsCloudTrailTrails::BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::CloudTrail::Client
-
-      def describe_trails(query)
-        aws_service_client.describe_trails(query)
-      end
-    end
-  end
-end
+class AwsCloudTrailTrails < Inspec.resource(1)
+  name 'aws_cloudtrail_trails'
+  desc 'Verifies settings for AWS CloudTrail Trails in bulk'
+  example '
+    describe aws_cloudtrail_trails do
+      it { should exist }
+    end
+  '
+  supports platform: 'aws'
+
+  include AwsPluralResourceMixin
+
+  def validate_params(resource_params)
+    unless resource_params.empty?
+      raise ArgumentError, 'aws_cloudtrail_trails does not accept resource parameters.'
+    end
+    resource_params
+  end
+
+  # Underlying FilterTable implementation.
+  filter = FilterTable.create
+  filter.add_accessor(:entries)
+        .add(:exists?) { |x| !x.entries.empty? }
+        .add(:names, field: :name)
+        .add(:trail_arns, field: :trail_arn)
+  filter.connect(self, :table)
+
+  def to_s
+    'CloudTrail Trails'
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+    @table = backend.describe_trails({}).to_h[:trail_list]
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      AwsCloudTrailTrails::BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::CloudTrail::Client
+
+      def describe_trails(query)
+        aws_service_client.describe_trails(query)
+      end
+    end
+  end
+end

data/lib/resources/aws/aws_cloudwatch_alarm.rb

@@ -1,62 +1,62 @@
-class AwsCloudwatchAlarm < Inspec.resource(1)
-  name 'aws_cloudwatch_alarm'
-  desc <<-EOD
-  # Look for a specific alarm
-  aws_cloudwatch_alarm(
-    metric: 'my-metric-name',
-    metric_namespace: 'my-metric-namespace',
-  ) do
-    it { should exist }
-  end
-  EOD
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-  attr_reader :alarm_actions, :alarm_name, :metric_name, :metric_namespace
-
-  private
-
-  def validate_params(raw_params)
-    recognized_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:metric_name, :metric_namespace],
-    )
-    validated_params = {}
-    # Currently you must specify exactly metric_name and metric_namespace
-    [:metric_name, :metric_namespace].each do |param|
-      raise ArgumentError, "Missing resource param #{param}" unless recognized_params.key?(param)
-      validated_params[param] = recognized_params.delete(param)
-    end
-
-    validated_params
-  end
-
-  def fetch_from_api
-    aws_alarms = BackendFactory.create(inspec_runner).describe_alarms_for_metric(
-      metric_name: @metric_name,
-      namespace: @metric_namespace,
-    )
-    if aws_alarms.metric_alarms.empty?
-      @exists = false
-    elsif aws_alarms.metric_alarms.count > 1
-      alarms = aws_alarms.metric_alarms.map(&:alarm_name)
-      raise 'More than one Cloudwatch Alarm was matched. Try using ' \
-        "more specific resource parameters. Alarms matched: #{alarms.join(', ')}"
-    else
-      @alarm_actions = aws_alarms.metric_alarms.first.alarm_actions
-      @alarm_name = aws_alarms.metric_alarms.first.alarm_name
-      @exists = true
-    end
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      AwsCloudwatchAlarm::BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::CloudWatch::Client
-
-      def describe_alarms_for_metric(query)
-        aws_service_client.describe_alarms_for_metric(query)
-      end
-    end
-  end
-end
+class AwsCloudwatchAlarm < Inspec.resource(1)
+  name 'aws_cloudwatch_alarm'
+  desc <<-EOD
+  # Look for a specific alarm
+  aws_cloudwatch_alarm(
+    metric: 'my-metric-name',
+    metric_namespace: 'my-metric-namespace',
+  ) do
+    it { should exist }
+  end
+  EOD
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+  attr_reader :alarm_actions, :alarm_name, :metric_name, :metric_namespace
+
+  private
+
+  def validate_params(raw_params)
+    recognized_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:metric_name, :metric_namespace],
+    )
+    validated_params = {}
+    # Currently you must specify exactly metric_name and metric_namespace
+    [:metric_name, :metric_namespace].each do |param|
+      raise ArgumentError, "Missing resource param #{param}" unless recognized_params.key?(param)
+      validated_params[param] = recognized_params.delete(param)
+    end
+
+    validated_params
+  end
+
+  def fetch_from_api
+    aws_alarms = BackendFactory.create(inspec_runner).describe_alarms_for_metric(
+      metric_name: @metric_name,
+      namespace: @metric_namespace,
+    )
+    if aws_alarms.metric_alarms.empty?
+      @exists = false
+    elsif aws_alarms.metric_alarms.count > 1
+      alarms = aws_alarms.metric_alarms.map(&:alarm_name)
+      raise 'More than one Cloudwatch Alarm was matched. Try using ' \
+        "more specific resource parameters. Alarms matched: #{alarms.join(', ')}"
+    else
+      @alarm_actions = aws_alarms.metric_alarms.first.alarm_actions
+      @alarm_name = aws_alarms.metric_alarms.first.alarm_name
+      @exists = true
+    end
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      AwsCloudwatchAlarm::BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::CloudWatch::Client
+
+      def describe_alarms_for_metric(query)
+        aws_service_client.describe_alarms_for_metric(query)
+      end
+    end
+  end
+end