inspec 2.0.16 → 2.0.17

data/lib/resources/aws/aws_iam_policy.rb

@@ -1,119 +1,119 @@
-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)
-
-    criteria = { max_items: 1000 } # maxItems max value is 1000
-    resp = backend.list_policies(criteria)
-    @policy = resp.policies.detect do |policy|
-      policy.policy_name == @policy_name
-    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)
+
+    criteria = { max_items: 1000 } # maxItems max value is 1000
+    resp = backend.list_policies(criteria)
+    @policy = resp.policies.detect do |policy|
+      policy.policy_name == @policy_name
+    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

data/lib/resources/aws/aws_iam_role.rb

@@ -1,51 +1,51 @@
-class AwsIamRole < Inspec.resource(1)
-  name 'aws_iam_role'
-  desc 'Verifies settings for an IAM Role'
-  example "
-    describe aws_iam_role('my-role') do
-      it { should exist }
-    end
-  "
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-  attr_reader :description, :role_name
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:role_name],
-      allowed_scalar_name: :role_name,
-      allowed_scalar_type: String,
-    )
-    if validated_params.empty?
-      raise ArgumentError, 'You must provide a role_name to aws_iam_role.'
-    end
-    validated_params
-  end
-
-  def fetch_from_api
-    role_info = nil
-    begin
-      role_info = BackendFactory.create(inspec_runner).get_role(role_name: role_name)
-    rescue Aws::IAM::Errors::NoSuchEntity
-      @exists = false
-      return
-    end
-    @exists = true
-    @description = role_info.role.description
-  end
-
-  # Uses the SDK API to really talk to AWS
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::IAM::Client
-      def get_role(query)
-        aws_service_client.get_role(query)
-      end
-    end
-  end
-end
+class AwsIamRole < Inspec.resource(1)
+  name 'aws_iam_role'
+  desc 'Verifies settings for an IAM Role'
+  example "
+    describe aws_iam_role('my-role') do
+      it { should exist }
+    end
+  "
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+  attr_reader :description, :role_name
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:role_name],
+      allowed_scalar_name: :role_name,
+      allowed_scalar_type: String,
+    )
+    if validated_params.empty?
+      raise ArgumentError, 'You must provide a role_name to aws_iam_role.'
+    end
+    validated_params
+  end
+
+  def fetch_from_api
+    role_info = nil
+    begin
+      role_info = BackendFactory.create(inspec_runner).get_role(role_name: role_name)
+    rescue Aws::IAM::Errors::NoSuchEntity
+      @exists = false
+      return
+    end
+    @exists = true
+    @description = role_info.role.description
+  end
+
+  # Uses the SDK API to really talk to AWS
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::IAM::Client
+      def get_role(query)
+        aws_service_client.get_role(query)
+      end
+    end
+  end
+end

data/lib/resources/aws/aws_iam_root_user.rb

@@ -1,60 +1,60 @@
-class AwsIamRootUser < Inspec.resource(1)
-  name 'aws_iam_root_user'
-  desc 'Verifies settings for AWS root account'
-  example "
-    describe aws_iam_root_user do
-      it { should have_access_key }
-    end
-  "
-  supports platform: 'aws'
-
-  # TODO: rewrite to avoid direct injection, match other resources, use AwsSingularResourceMixin
-  def initialize(conn = nil)
-    @client = conn ? conn.iam_client : inspec_runner.backend.aws_client(Aws::IAM::Client)
-  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 has_access_key?
-    summary_account['AccountAccessKeysPresent'] == 1
-  end
-
-  def has_mfa_enabled?
-    summary_account['AccountMFAEnabled'] == 1
-  end
-
-  def to_s
-    'AWS Root-User'
-  end
-
-  private
-
-  def summary_account
-    catch_aws_errors do
-      @summary_account ||= @client.get_account_summary.summary_map
-    end
-  end
-end
+class AwsIamRootUser < Inspec.resource(1)
+  name 'aws_iam_root_user'
+  desc 'Verifies settings for AWS root account'
+  example "
+    describe aws_iam_root_user do
+      it { should have_access_key }
+    end
+  "
+  supports platform: 'aws'
+
+  # TODO: rewrite to avoid direct injection, match other resources, use AwsSingularResourceMixin
+  def initialize(conn = nil)
+    @client = conn ? conn.iam_client : inspec_runner.backend.aws_client(Aws::IAM::Client)
+  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 has_access_key?
+    summary_account['AccountAccessKeysPresent'] == 1
+  end
+
+  def has_mfa_enabled?
+    summary_account['AccountMFAEnabled'] == 1
+  end
+
+  def to_s
+    'AWS Root-User'
+  end
+
+  private
+
+  def summary_account
+    catch_aws_errors do
+      @summary_account ||= @client.get_account_summary.summary_map
+    end
+  end
+end