inspec 2.1.81 → 2.1.83

data/lib/resources/aws/aws_iam_role.rb

@@ -1,55 +1,55 @@
-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
-
-  def to_s
-    "IAM Role #{role_name}"
-  end
-
-  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
+
+  def to_s
+    "IAM Role #{role_name}"
+  end
+
+  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,78 +1,78 @@
-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
-
-  # if the root account has a Virtual MFA device then it will have a special
-  # serial number ending in 'root-account-mfa-device'
-  def has_virtual_mfa_enabled?
-    mfa_device_pattern = %r{arn:aws:iam::\d{12}:mfa\/root-account-mfa-device}
-
-    virtual_mfa_devices.any? { |d| mfa_device_pattern =~ d['serial_number'] }
-  end
-
-  def has_hardware_mfa_enabled?
-    has_mfa_enabled? && !has_virtual_mfa_enabled?
-  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
-
-  def virtual_mfa_devices
-    catch_aws_errors do
-      @__virtual_devices ||= @client.list_virtual_mfa_devices.virtual_mfa_devices
-    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
+
+  # if the root account has a Virtual MFA device then it will have a special
+  # serial number ending in 'root-account-mfa-device'
+  def has_virtual_mfa_enabled?
+    mfa_device_pattern = %r{arn:aws:iam::\d{12}:mfa\/root-account-mfa-device}
+
+    virtual_mfa_devices.any? { |d| mfa_device_pattern =~ d['serial_number'] }
+  end
+
+  def has_hardware_mfa_enabled?
+    has_mfa_enabled? && !has_virtual_mfa_enabled?
+  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
+
+  def virtual_mfa_devices
+    catch_aws_errors do
+      @__virtual_devices ||= @client.list_virtual_mfa_devices.virtual_mfa_devices
+    end
+  end
+end

data/lib/resources/aws/aws_iam_user.rb

@@ -1,142 +1,142 @@
-# author: Alex Bedley
-# author: Steffanie Freeman
-# author: Simon Varlow
-# author: Chris Redekop
-class AwsIamUser < Inspec.resource(1)
-  name 'aws_iam_user'
-  desc 'Verifies settings for AWS IAM user'
-  example "
-    describe aws_iam_user(username: 'test_user') do
-      it { should have_mfa_enabled }
-      it { should_not have_console_password }
-      it { should_not have_inline_user_policies }
-      it { should_not have_attached_user_policies }
-    end
-  "
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-  attr_reader :access_keys, :attached_policy_names, :attached_policy_arns, \
-              :has_console_password, :has_mfa_enabled, :inline_policy_names, :username
-  alias has_mfa_enabled? has_mfa_enabled
-  alias has_console_password? has_console_password
-
-  def name
-    warn "[DEPRECATION] - Property ':name' is deprecated on the aws_iam_user resource.  Use ':username' instead."
-    username
-  end
-
-  def to_s
-    "IAM User #{username}"
-  end
-
-  def has_attached_policies?
-    return nil unless exists?
-    !attached_policy_names.empty?
-  end
-
-  def has_inline_policies?
-    return nil unless exists?
-    !inline_policy_names.empty?
-  end
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:username, :aws_user_struct, :name, :user],
-      allowed_scalar_name: :username,
-      allowed_scalar_type: String,
-    )
-    # If someone passed :name, rename it to :username
-    if validated_params.key?(:name)
-      warn "[DEPRECATION] - Resource parameter ':name' is deprecated on the aws_iam_user resource.  Use ':username' instead."
-      validated_params[:username] = validated_params.delete(:name)
-    end
-
-    # If someone passed :user, rename it to :aws_user_struct
-    if validated_params.key?(:user)
-      warn "[DEPRECATION] - Resource parameter ':user' is deprecated on the aws_iam_user resource.  Use ':aws_user_struct' instead."
-      validated_params[:aws_user_struct] = validated_params.delete(:user)
-    end
-
-    if validated_params.empty?
-      raise ArgumentError, 'You must provide a username to aws_iam_user.'
-    end
-    validated_params
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-    @aws_user_struct ||= nil # silence unitialized warning
-    unless @aws_user_struct
-      begin
-        @aws_user_struct = backend.get_user(user_name: username)
-      rescue Aws::IAM::Errors::NoSuchEntity
-        @exists = false
-        @access_keys = []
-        @inline_policy_names = []
-        @attached_policy_arns = []
-        @attached_policy_names = []
-        return
-      end
-    end
-    # TODO: extract properties from aws_user_struct?
-
-    @exists = true
-
-    begin
-      _login_profile = backend.get_login_profile(user_name: username)
-      @has_console_password = true
-      # Password age also available here
-    rescue Aws::IAM::Errors::NoSuchEntity
-      @has_console_password = false
-    end
-
-    mfa_info = backend.list_mfa_devices(user_name: username)
-    @has_mfa_enabled = !mfa_info.mfa_devices.empty?
-
-    # TODO: consider returning Inspec AwsIamAccessKey objects
-    @access_keys = backend.list_access_keys(user_name: username).access_key_metadata
-    # If the above call fails, we get nil here; but we promise access_keys will be an array.
-    @access_keys ||= []
-
-    @inline_policy_names = backend.list_user_policies(user_name: username).policy_names
-
-    attached_policies = backend.list_attached_user_policies(user_name: username).attached_policies
-    @attached_policy_arns = attached_policies.map { |p| p[:policy_arn] }
-    @attached_policy_names = attached_policies.map { |p| p[:policy_name] }
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::IAM::Client
-
-      def get_user(criteria)
-        aws_service_client.get_user(criteria)
-      end
-
-      def get_login_profile(criteria)
-        aws_service_client.get_login_profile(criteria)
-      end
-
-      def list_mfa_devices(criteria)
-        aws_service_client.list_mfa_devices(criteria)
-      end
-
-      def list_access_keys(criteria)
-        aws_service_client.list_access_keys(criteria)
-      end
-
-      def list_user_policies(criteria)
-        aws_service_client.list_user_policies(criteria)
-      end
-
-      def list_attached_user_policies(criteria)
-        aws_service_client.list_attached_user_policies(criteria)
-      end
-    end
-  end
-end
+# author: Alex Bedley
+# author: Steffanie Freeman
+# author: Simon Varlow
+# author: Chris Redekop
+class AwsIamUser < Inspec.resource(1)
+  name 'aws_iam_user'
+  desc 'Verifies settings for AWS IAM user'
+  example "
+    describe aws_iam_user(username: 'test_user') do
+      it { should have_mfa_enabled }
+      it { should_not have_console_password }
+      it { should_not have_inline_user_policies }
+      it { should_not have_attached_user_policies }
+    end
+  "
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+  attr_reader :access_keys, :attached_policy_names, :attached_policy_arns, \
+              :has_console_password, :has_mfa_enabled, :inline_policy_names, :username
+  alias has_mfa_enabled? has_mfa_enabled
+  alias has_console_password? has_console_password
+
+  def name
+    warn "[DEPRECATION] - Property ':name' is deprecated on the aws_iam_user resource.  Use ':username' instead."
+    username
+  end
+
+  def to_s
+    "IAM User #{username}"
+  end
+
+  def has_attached_policies?
+    return nil unless exists?
+    !attached_policy_names.empty?
+  end
+
+  def has_inline_policies?
+    return nil unless exists?
+    !inline_policy_names.empty?
+  end
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:username, :aws_user_struct, :name, :user],
+      allowed_scalar_name: :username,
+      allowed_scalar_type: String,
+    )
+    # If someone passed :name, rename it to :username
+    if validated_params.key?(:name)
+      warn "[DEPRECATION] - Resource parameter ':name' is deprecated on the aws_iam_user resource.  Use ':username' instead."
+      validated_params[:username] = validated_params.delete(:name)
+    end
+
+    # If someone passed :user, rename it to :aws_user_struct
+    if validated_params.key?(:user)
+      warn "[DEPRECATION] - Resource parameter ':user' is deprecated on the aws_iam_user resource.  Use ':aws_user_struct' instead."
+      validated_params[:aws_user_struct] = validated_params.delete(:user)
+    end
+
+    if validated_params.empty?
+      raise ArgumentError, 'You must provide a username to aws_iam_user.'
+    end
+    validated_params
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+    @aws_user_struct ||= nil # silence unitialized warning
+    unless @aws_user_struct
+      begin
+        @aws_user_struct = backend.get_user(user_name: username)
+      rescue Aws::IAM::Errors::NoSuchEntity
+        @exists = false
+        @access_keys = []
+        @inline_policy_names = []
+        @attached_policy_arns = []
+        @attached_policy_names = []
+        return
+      end
+    end
+    # TODO: extract properties from aws_user_struct?
+
+    @exists = true
+
+    begin
+      _login_profile = backend.get_login_profile(user_name: username)
+      @has_console_password = true
+      # Password age also available here
+    rescue Aws::IAM::Errors::NoSuchEntity
+      @has_console_password = false
+    end
+
+    mfa_info = backend.list_mfa_devices(user_name: username)
+    @has_mfa_enabled = !mfa_info.mfa_devices.empty?
+
+    # TODO: consider returning Inspec AwsIamAccessKey objects
+    @access_keys = backend.list_access_keys(user_name: username).access_key_metadata
+    # If the above call fails, we get nil here; but we promise access_keys will be an array.
+    @access_keys ||= []
+
+    @inline_policy_names = backend.list_user_policies(user_name: username).policy_names
+
+    attached_policies = backend.list_attached_user_policies(user_name: username).attached_policies
+    @attached_policy_arns = attached_policies.map { |p| p[:policy_arn] }
+    @attached_policy_names = attached_policies.map { |p| p[:policy_name] }
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::IAM::Client
+
+      def get_user(criteria)
+        aws_service_client.get_user(criteria)
+      end
+
+      def get_login_profile(criteria)
+        aws_service_client.get_login_profile(criteria)
+      end
+
+      def list_mfa_devices(criteria)
+        aws_service_client.list_mfa_devices(criteria)
+      end
+
+      def list_access_keys(criteria)
+        aws_service_client.list_access_keys(criteria)
+      end
+
+      def list_user_policies(criteria)
+        aws_service_client.list_user_policies(criteria)
+      end
+
+      def list_attached_user_policies(criteria)
+        aws_service_client.list_attached_user_policies(criteria)
+      end
+    end
+  end
+end