inspec 2.1.21 → 2.1.30

data/lib/resources/aws/aws_iam_password_policy.rb

@@ -1,116 +1,116 @@
-# author: Viktor Yakovlyev
-class AwsIamPasswordPolicy < Inspec.resource(1)
-  name 'aws_iam_password_policy'
-  desc 'Verifies iam password policy'
-
-  example <<-EOX
-    describe aws_iam_password_policy do
-      its('requires_lowercase_characters?') { should be true }
-    end
-
-    describe aws_iam_password_policy do
-      its('requires_uppercase_characters?') { should be true }
-    end
-EOX
-  supports platform: 'aws'
-
-  # TODO: rewrite to avoid direct injection, match other resources, use AwsSingularResourceMixin
-  def initialize(conn = nil)
-    catch_aws_errors do
-      begin
-        if conn
-          # We're in a mocked unit test.
-          @policy = conn.iam_resource.account_password_policy
-        else
-          # Don't use the resource approach.  It's a CRUD operation
-          # - if the policy does not exist, you get back a blank object to  populate and save.
-          # Using the Client will throw an exception if no policy exists.
-          @policy = inspec_runner.backend.aws_client(Aws::IAM::Client).get_account_password_policy.password_policy
-        end
-      rescue Aws::IAM::Errors::NoSuchEntity
-        @policy = nil
-      end
-    end
-  end
-
-  # TODO: DRY up, see https://github.com/chef/inspec/issues/2633
-  # Copied from resource_support/aws/aws_resource_mixin.rb
-  def catch_aws_errors
-    yield
-  rescue Aws::Errors::MissingCredentialsError
-    # The AWS error here is unhelpful:
-    # "unable to sign request without credentials set"
-    Inspec::Log.error "It appears that you have not set your AWS credentials.  You may set them using environment variables, or using the 'aws://region/aws_credentials_profile' target.  See https://www.inspec.io/docs/reference/platforms for details."
-    fail_resource('No AWS credentials available')
-  rescue Aws::Errors::ServiceError => e
-    fail_resource e.message
-  end
-
-  # TODO: DRY up, see https://github.com/chef/inspec/issues/2633
-  # Copied from resource_support/aws/aws_singular_resource_mixin.rb
-  def inspec_runner
-    # When running under inspec-cli, we have an 'inspec' method that
-    # returns the runner. When running under unit tests, we don't
-    # have that, but we still have to call this to pass something
-    # (nil is OK) to the backend.
-    # TODO: remove with https://github.com/chef/inspec-aws/issues/216
-    # TODO: remove after rewrite to include AwsSingularResource
-    inspec if respond_to?(:inspec)
-  end
-
-  def to_s
-    'IAM Password-Policy'
-  end
-
-  def exists?
-    !@policy.nil?
-  end
-
-  #-------------------------- Properties ----------------------------#
-
-  def minimum_password_length
-    @policy.minimum_password_length
-  end
-
-  def max_password_age_in_days
-    raise 'this policy does not expire passwords' unless expire_passwords?
-    @policy.max_password_age
-  end
-
-  def number_of_passwords_to_remember
-    raise 'this policy does not prevent password reuse' \
-      unless prevent_password_reuse?
-    @policy.password_reuse_prevention
-  end
-
-  #-------------------------- Matchers ----------------------------#
-  [
-    :require_lowercase_characters,
-    :require_uppercase_characters,
-    :require_symbols,
-    :require_numbers,
-    :expire_passwords,
-  ].each do |matcher_stem|
-    # Create our predicates (for example, 'require_symbols?')
-    stem_with_question_mark = (matcher_stem.to_s + '?').to_sym
-    define_method stem_with_question_mark do
-      @policy.send(matcher_stem)
-    end
-    # RSpec will expose that as (for example) `be_require_symbols`.
-    # To undo that, we have to make a matcher alias.
-    stem_with_be = ('be_' + matcher_stem.to_s).to_sym
-    RSpec::Matchers.alias_matcher matcher_stem, stem_with_be
-  end
-
-  # This one has an awkward name mapping
-  def allow_users_to_change_passwords?
-    @policy.allow_users_to_change_password
-  end
-  RSpec::Matchers.alias_matcher :allow_users_to_change_passwords, :be_allow_users_to_change_passwords
-
-  # This one has custom logic and renaming
-  def prevent_password_reuse?
-    !@policy.password_reuse_prevention.nil?
-  end
-  RSpec::Matchers.alias_matcher :prevent_password_reuse, :be_prevent_password_reuse
-end
+# author: Viktor Yakovlyev
+class AwsIamPasswordPolicy < Inspec.resource(1)
+  name 'aws_iam_password_policy'
+  desc 'Verifies iam password policy'
+
+  example <<-EOX
+    describe aws_iam_password_policy do
+      its('requires_lowercase_characters?') { should be true }
+    end
+
+    describe aws_iam_password_policy do
+      its('requires_uppercase_characters?') { should be true }
+    end
+EOX
+  supports platform: 'aws'
+
+  # TODO: rewrite to avoid direct injection, match other resources, use AwsSingularResourceMixin
+  def initialize(conn = nil)
+    catch_aws_errors do
+      begin
+        if conn
+          # We're in a mocked unit test.
+          @policy = conn.iam_resource.account_password_policy
+        else
+          # Don't use the resource approach.  It's a CRUD operation
+          # - if the policy does not exist, you get back a blank object to  populate and save.
+          # Using the Client will throw an exception if no policy exists.
+          @policy = inspec_runner.backend.aws_client(Aws::IAM::Client).get_account_password_policy.password_policy
+        end
+      rescue Aws::IAM::Errors::NoSuchEntity
+        @policy = nil
+      end
+    end
+  end
+
+  # TODO: DRY up, see https://github.com/chef/inspec/issues/2633
+  # Copied from resource_support/aws/aws_resource_mixin.rb
+  def catch_aws_errors
+    yield
+  rescue Aws::Errors::MissingCredentialsError
+    # The AWS error here is unhelpful:
+    # "unable to sign request without credentials set"
+    Inspec::Log.error "It appears that you have not set your AWS credentials.  You may set them using environment variables, or using the 'aws://region/aws_credentials_profile' target.  See https://www.inspec.io/docs/reference/platforms for details."
+    fail_resource('No AWS credentials available')
+  rescue Aws::Errors::ServiceError => e
+    fail_resource e.message
+  end
+
+  # TODO: DRY up, see https://github.com/chef/inspec/issues/2633
+  # Copied from resource_support/aws/aws_singular_resource_mixin.rb
+  def inspec_runner
+    # When running under inspec-cli, we have an 'inspec' method that
+    # returns the runner. When running under unit tests, we don't
+    # have that, but we still have to call this to pass something
+    # (nil is OK) to the backend.
+    # TODO: remove with https://github.com/chef/inspec-aws/issues/216
+    # TODO: remove after rewrite to include AwsSingularResource
+    inspec if respond_to?(:inspec)
+  end
+
+  def to_s
+    'IAM Password-Policy'
+  end
+
+  def exists?
+    !@policy.nil?
+  end
+
+  #-------------------------- Properties ----------------------------#
+
+  def minimum_password_length
+    @policy.minimum_password_length
+  end
+
+  def max_password_age_in_days
+    raise 'this policy does not expire passwords' unless expire_passwords?
+    @policy.max_password_age
+  end
+
+  def number_of_passwords_to_remember
+    raise 'this policy does not prevent password reuse' \
+      unless prevent_password_reuse?
+    @policy.password_reuse_prevention
+  end
+
+  #-------------------------- Matchers ----------------------------#
+  [
+    :require_lowercase_characters,
+    :require_uppercase_characters,
+    :require_symbols,
+    :require_numbers,
+    :expire_passwords,
+  ].each do |matcher_stem|
+    # Create our predicates (for example, 'require_symbols?')
+    stem_with_question_mark = (matcher_stem.to_s + '?').to_sym
+    define_method stem_with_question_mark do
+      @policy.send(matcher_stem)
+    end
+    # RSpec will expose that as (for example) `be_require_symbols`.
+    # To undo that, we have to make a matcher alias.
+    stem_with_be = ('be_' + matcher_stem.to_s).to_sym
+    RSpec::Matchers.alias_matcher matcher_stem, stem_with_be
+  end
+
+  # This one has an awkward name mapping
+  def allow_users_to_change_passwords?
+    @policy.allow_users_to_change_password
+  end
+  RSpec::Matchers.alias_matcher :allow_users_to_change_passwords, :be_allow_users_to_change_passwords
+
+  # This one has custom logic and renaming
+  def prevent_password_reuse?
+    !@policy.password_reuse_prevention.nil?
+  end
+  RSpec::Matchers.alias_matcher :prevent_password_reuse, :be_prevent_password_reuse
+end

data/lib/resources/aws/aws_iam_policies.rb

@@ -1,53 +1,53 @@
-class AwsIamPolicies < Inspec.resource(1)
-  name 'aws_iam_policies'
-  desc 'Verifies settings for AWS IAM Policies in bulk'
-  example '
-    describe aws_iam_policies do
-      it { should exist }
-    end
-  '
-  supports platform: 'aws'
-
-  include AwsPluralResourceMixin
-  def validate_params(resource_params)
-    unless resource_params.empty?
-      raise ArgumentError, 'aws_iam_policies 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(:policy_names, field: :policy_name)
-        .add(:arns, field: :arn)
-  filter.connect(self, :table)
-
-  def to_s
-    'IAM Policies'
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-    @table = []
-    pagination_opts = {}
-    loop do
-      api_result = backend.list_policies(pagination_opts)
-      @table += api_result.policies.map(&:to_h)
-      pagination_opts = { marker: api_result.marker }
-      break unless api_result.is_truncated
-    end
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::IAM::Client
-
-      def list_policies(query)
-        aws_service_client.list_policies(query)
-      end
-    end
-  end
-end
+class AwsIamPolicies < Inspec.resource(1)
+  name 'aws_iam_policies'
+  desc 'Verifies settings for AWS IAM Policies in bulk'
+  example '
+    describe aws_iam_policies do
+      it { should exist }
+    end
+  '
+  supports platform: 'aws'
+
+  include AwsPluralResourceMixin
+  def validate_params(resource_params)
+    unless resource_params.empty?
+      raise ArgumentError, 'aws_iam_policies 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(:policy_names, field: :policy_name)
+        .add(:arns, field: :arn)
+  filter.connect(self, :table)
+
+  def to_s
+    'IAM Policies'
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+    @table = []
+    pagination_opts = {}
+    loop do
+      api_result = backend.list_policies(pagination_opts)
+      @table += api_result.policies.map(&:to_h)
+      pagination_opts = { marker: api_result.marker }
+      break unless api_result.is_truncated
+    end
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::IAM::Client
+
+      def list_policies(query)
+        aws_service_client.list_policies(query)
+      end
+    end
+  end
+end

data/lib/resources/aws/aws_iam_policy.rb

@@ -1,125 +1,125 @@
-class AwsIamPolicy < Inspec.resource(1)
-  name 'aws_iam_policy'
-  desc 'Verifies settings for individual AWS IAM Policy'
-  example "
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should be_attached }
-    end
-  "
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-
-  attr_reader :arn, :attachment_count, :default_version_id
-
-  def to_s
-    "Policy #{@policy_name}"
-  end
-
-  def attached?
-    !attachment_count.zero?
-  end
-
-  def attached_users
-    return @attached_users if defined? @attached_users
-    fetch_attached_entities
-    @attached_users
-  end
-
-  def attached_groups
-    return @attached_groups if defined? @attached_groups
-    fetch_attached_entities
-    @attached_groups
-  end
-
-  def attached_roles
-    return @attached_roles if defined? @attached_roles
-    fetch_attached_entities
-    @attached_roles
-  end
-
-  def attached_to_user?(user_name)
-    attached_users.include?(user_name)
-  end
-
-  def attached_to_group?(group_name)
-    attached_groups.include?(group_name)
-  end
-
-  def attached_to_role?(role_name)
-    attached_roles.include?(role_name)
-  end
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:policy_name],
-      allowed_scalar_name: :policy_name,
-      allowed_scalar_type: String,
-    )
-
-    if validated_params.empty?
-      raise ArgumentError, "You must provide the parameter 'policy_name' to aws_iam_policy."
-    end
-
-    validated_params
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-
-    policy = nil
-    pagination_opts = { max_items: 1000 }
-    loop do
-      api_result = backend.list_policies(pagination_opts)
-      policy = api_result.policies.detect do |p|
-        p.policy_name == @policy_name
-      end
-      break if policy # Found it!
-      break unless api_result.is_truncated # Not found and no more results
-      pagination_opts[:marker] = api_result.marker
-    end
-
-    @exists = !policy.nil?
-
-    return unless @exists
-    @arn = policy[:arn]
-    @default_version_id = policy[:default_version_id]
-    @attachment_count = policy[:attachment_count]
-  end
-
-  def fetch_attached_entities
-    unless @exists
-      @attached_groups = nil
-      @attached_users  = nil
-      @attached_roles  = nil
-      return
-    end
-    backend = AwsIamPolicy::BackendFactory.create(inspec_runner)
-    criteria = { policy_arn: arn }
-    resp = nil
-    catch_aws_errors do
-      resp = backend.list_entities_for_policy(criteria)
-    end
-    @attached_groups = resp.policy_groups.map(&:group_name)
-    @attached_users  = resp.policy_users.map(&:user_name)
-    @attached_roles  = resp.policy_roles.map(&:role_name)
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::IAM::Client
-
-      def list_policies(criteria)
-        aws_service_client.list_policies(criteria)
-      end
-
-      def list_entities_for_policy(criteria)
-        aws_service_client.list_entities_for_policy(criteria)
-      end
-    end
-  end
-end
+class AwsIamPolicy < Inspec.resource(1)
+  name 'aws_iam_policy'
+  desc 'Verifies settings for individual AWS IAM Policy'
+  example "
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should be_attached }
+    end
+  "
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+
+  attr_reader :arn, :attachment_count, :default_version_id
+
+  def to_s
+    "Policy #{@policy_name}"
+  end
+
+  def attached?
+    !attachment_count.zero?
+  end
+
+  def attached_users
+    return @attached_users if defined? @attached_users
+    fetch_attached_entities
+    @attached_users
+  end
+
+  def attached_groups
+    return @attached_groups if defined? @attached_groups
+    fetch_attached_entities
+    @attached_groups
+  end
+
+  def attached_roles
+    return @attached_roles if defined? @attached_roles
+    fetch_attached_entities
+    @attached_roles
+  end
+
+  def attached_to_user?(user_name)
+    attached_users.include?(user_name)
+  end
+
+  def attached_to_group?(group_name)
+    attached_groups.include?(group_name)
+  end
+
+  def attached_to_role?(role_name)
+    attached_roles.include?(role_name)
+  end
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:policy_name],
+      allowed_scalar_name: :policy_name,
+      allowed_scalar_type: String,
+    )
+
+    if validated_params.empty?
+      raise ArgumentError, "You must provide the parameter 'policy_name' to aws_iam_policy."
+    end
+
+    validated_params
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+
+    policy = nil
+    pagination_opts = { max_items: 1000 }
+    loop do
+      api_result = backend.list_policies(pagination_opts)
+      policy = api_result.policies.detect do |p|
+        p.policy_name == @policy_name
+      end
+      break if policy # Found it!
+      break unless api_result.is_truncated # Not found and no more results
+      pagination_opts[:marker] = api_result.marker
+    end
+
+    @exists = !policy.nil?
+
+    return unless @exists
+    @arn = policy[:arn]
+    @default_version_id = policy[:default_version_id]
+    @attachment_count = policy[:attachment_count]
+  end
+
+  def fetch_attached_entities
+    unless @exists
+      @attached_groups = nil
+      @attached_users  = nil
+      @attached_roles  = nil
+      return
+    end
+    backend = AwsIamPolicy::BackendFactory.create(inspec_runner)
+    criteria = { policy_arn: arn }
+    resp = nil
+    catch_aws_errors do
+      resp = backend.list_entities_for_policy(criteria)
+    end
+    @attached_groups = resp.policy_groups.map(&:group_name)
+    @attached_users  = resp.policy_users.map(&:user_name)
+    @attached_roles  = resp.policy_roles.map(&:role_name)
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::IAM::Client
+
+      def list_policies(criteria)
+        aws_service_client.list_policies(criteria)
+      end
+
+      def list_entities_for_policy(criteria)
+        aws_service_client.list_entities_for_policy(criteria)
+      end
+    end
+  end
+end