cfn-nag 0.7.15 → 0.8.2

data/lib/cfn-nag/custom_rules/IamUserLoginProfilePasswordResetRule.rb

@@ -29,9 +29,7 @@ class IamUserLoginProfilePasswordResetRule < BaseRule
 
   def iam_user_password_reset_required_key?(login_profile)
     if login_profile.key? 'PasswordResetRequired'
-      if login_profile['PasswordResetRequired'].nil?
-        true
-      elsif not_truthy?(login_profile['PasswordResetRequired'])
+      if login_profile['PasswordResetRequired'].nil? || not_truthy?(login_profile['PasswordResetRequired'])
         true
       end
     else
@@ -40,10 +38,10 @@ class IamUserLoginProfilePasswordResetRule < BaseRule
   end
 
   def violating_iam_users?(iam_user)
-    if !iam_user.loginProfile.nil?
-      iam_user_password_reset_required_key?(iam_user.loginProfile)
-    else
+    if iam_user.loginProfile.nil?
       false
+    else
+      iam_user_password_reset_required_key?(iam_user.loginProfile)
     end
   end
 end

data/lib/cfn-nag/custom_rules/KMSKeyWildcardPrincipalRule.rb

@@ -6,7 +6,7 @@ require_relative 'base'
 class KMSKeyWildcardPrincipalRule < BaseRule
   def rule_text
     'KMS key should not allow * principal ' \
-    '(https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)'
+      '(https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/KinesisFirehoseDeliveryStreamRedshiftDestinationConfigurationPasswordRule.rb

@@ -6,9 +6,9 @@ require_relative 'password_base_rule'
 class KinesisFirehoseDeliveryStreamRedshiftDestinationConfigurationPasswordRule < PasswordBaseRule
   def rule_text
     'Kinesis Firehose DeliveryStream RedshiftDestinationConfiguration Password ' \
-    'must not be a plaintext string or a Ref to a Parameter with a ' \
-    'Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'must not be a plaintext string or a Ref to a Parameter with a ' \
+      'Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/KinesisFirehoseDeliveryStreamSplunkDestinationConfigurationHECTokenRule.rb

@@ -6,9 +6,9 @@ require_relative 'password_base_rule'
 class KinesisFirehoseDeliveryStreamSplunkDestinationConfigurationHECTokenRule < PasswordBaseRule
   def rule_text
     'Kinesis Firehose DeliveryStream SplunkDestinationConfiguration HECToken ' \
-    'must not be a plaintext string or a Ref to a Parameter with a ' \
-    'Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'must not be a plaintext string or a Ref to a Parameter with a ' \
+      'Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/KinesisStreamStreamEncryptionRule.rb

@@ -27,11 +27,9 @@ class KinesisStreamStreamEncryptionRule < BaseRule
   private
 
   def violating_kinesis_streams?(kinesis_stream)
-    if kinesis_stream.streamEncryption.nil?
-      true
-    elsif kinesis_stream.streamEncryption['EncryptionType'].nil?
-      true
-    elsif kinesis_stream.streamEncryption['KeyId'].nil?
+    if kinesis_stream.streamEncryption.nil? ||
+       kinesis_stream.streamEncryption['EncryptionType'].nil? ||
+       kinesis_stream.streamEncryption['KeyId'].nil?
       true
     else
       kinesis_stream.streamEncryption['EncryptionType'] == 'NONE'

data/lib/cfn-nag/custom_rules/LambdaPermissionEventSourceTokenRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class LambdaPermissionEventSourceTokenRule < PasswordBaseRule
   def rule_text
     'Lambda Permission EventSourceToken must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/LambdaPermissionInvokeFunctionActionRule.rb

@@ -6,7 +6,7 @@ require_relative 'base'
 class LambdaPermissionInvokeFunctionActionRule < BaseRule
   def rule_text
     'Lambda permission beside InvokeFunction might not be what you want? ' \
-    'Not sure!?'
+      'Not sure!?'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/ManagedBlockchainMemberMemberFabricConfigurationAdminPasswordRule.rb

@@ -8,7 +8,7 @@ require_relative 'base'
 class ManagedBlockchainMemberMemberFabricConfigurationAdminPasswordRule < BaseRule
   def rule_text
     'ManagedBlockchain Member MemberFabricConfiguration AdminPasswordRule must ' \
-    'not be a plaintext string or a Ref to a NoEcho Parameter with a Default value.'
+      'not be a plaintext string or a Ref to a NoEcho Parameter with a Default value.'
   end
 
   def rule_type
@@ -42,14 +42,11 @@ class ManagedBlockchainMemberMemberFabricConfigurationAdminPasswordRule < BaseRu
   #   'MemberFabricConfiguration'
   #   'AdminPassword'
   def password_property_does_not_exist(member)
-    if member.memberConfiguration['MemberFrameworkConfiguration'].nil?
-      true
-    elsif member.memberConfiguration['MemberFrameworkConfiguration']['MemberFabricConfiguration'].nil?
-      true
-    elsif member.memberConfiguration['MemberFrameworkConfiguration']['MemberFabricConfiguration']['AdminPassword'].nil?
+    if member.memberConfiguration['MemberFrameworkConfiguration'].nil? ||
+       member.memberConfiguration['MemberFrameworkConfiguration']['MemberFabricConfiguration'].nil?
       true
     else
-      false
+      member.memberConfiguration['MemberFrameworkConfiguration']['MemberFabricConfiguration']['AdminPassword'].nil?
     end
   end
 end

data/lib/cfn-nag/custom_rules/OpsWorksAppAppSourcePasswordRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class OpsWorksAppAppSourcePasswordRule < PasswordBaseRule
   def rule_text
     'OpsWorks App AppSource Password must not be a plaintext ' \
-    'string or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'string or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/OpsWorksAppSslConfigurationPrivateKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class OpsWorksAppSslConfigurationPrivateKeyRule < PasswordBaseRule
   def rule_text
     'OpsWorks App SslConfiguration PrivateKey must not be a plaintext ' \
-    'string or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'string or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/OpsWorksStackCustomCookbooksSourcePasswordRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class OpsWorksStackCustomCookbooksSourcePasswordRule < PasswordBaseRule
   def rule_text
     'OpsWorks Stack CustomCookbooksSource Password must not be a plaintext ' \
-    'string or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'string or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/OpsWorksStackRdsDbInstancesDbPasswordRule.rb

@@ -6,8 +6,8 @@ require_relative 'sub_property_with_list_password_base_rule'
 class OpsWorksStackRdsDbInstancesDbPasswordRule < SubPropertyWithListPasswordBaseRule
   def rule_text
     'OpsWorks Stack RDS DbInstance DbPassword must not be a plaintext string '\
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSChannelPrivateKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSChannelPrivateKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSChannel PrivateKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSChannelTokenKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSChannelTokenKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSChannel TokenKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSSandboxChannelPrivateKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSSandboxChannelPrivateKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSSandboxChannel PrivateKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSSandboxChannelTokenKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSSandboxChannelTokenKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSSandboxChannel TokenKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSVoipChannelPrivateKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSVoipChannelPrivateKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSVoipChannel PrivateKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSVoipChannelTokenKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSVoipChannelTokenKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSChannel TokenKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSVoipSandboxChannelPrivateKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSVoipSandboxChannelPrivateKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSVoipSandboxChannel PrivateKey must not be a plaintext ' \
-    'string or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'string or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/PinpointAPNSVoipSandboxChannelTokenKeyRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class PinpointAPNSVoipSandboxChannelTokenKeyRule < PasswordBaseRule
   def rule_text
     'Pinpoint APNSVoipSandboxChannel TokenKey must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/RDSDBClusterMasterUserPasswordRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class RDSDBClusterMasterUserPasswordRule < PasswordBaseRule
   def rule_text
     'RDS DB Cluster master user password must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/RDSDBInstanceMasterUserPasswordRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class RDSDBInstanceMasterUserPasswordRule < PasswordBaseRule
   def rule_text
     'RDS instance master user password must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/RDSDBInstanceMasterUsernameRule.rb

@@ -7,8 +7,8 @@ require_relative 'password_base_rule'
 class RDSDBInstanceMasterUsernameRule < PasswordBaseRule
   def rule_text
     'RDS instance master username must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/RedshiftClusterMasterUserPasswordRule.rb

@@ -6,8 +6,8 @@ require_relative 'password_base_rule'
 class RedshiftClusterMasterUserPasswordRule < PasswordBaseRule
   def rule_text
     'Redshift Cluster master user password must not be a plaintext string ' \
-    'or a Ref to a Parameter with a Default value.  ' \
-    'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
+      'or a Ref to a Parameter with a Default value.  ' \
+      'Can be Ref to a NoEcho Parameter without a Default, or a dynamic reference to a secretsmanager/ssm-secure value.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/ResourceWithExplicitNameRule.rb

@@ -26,7 +26,7 @@ class ResourceWithExplicitNameRule < BaseRule
 
   def rule_text
     'Resource found with an explicit name, this disallows updates that ' \
-    'require replacement of this resource'
+      'require replacement of this resource'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/SecretsManagerSecretKmsKeyIdRule.rb

@@ -6,7 +6,7 @@ require_relative 'boolean_base_rule'
 class SecretsManagerSecretKmsKeyIdRule < BooleanBaseRule
   def rule_text
     'Secrets Manager Secret should explicitly specify KmsKeyId.' \
-    ' Besides control of the key this will allow the secret to be shared cross-account'
+      ' Besides control of the key this will allow the secret to be shared cross-account'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/SecurityGroupIngressOpenToWorldRule.rb

@@ -9,7 +9,7 @@ class SecurityGroupIngressOpenToWorldRule < BaseRule
 
   def rule_text
     'Security Groups found with cidr open to world on ingress.  This should ' \
-    'never be true on instance.  Permissible on ELB'
+      'never be true on instance.  Permissible on ELB'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/SecurityGroupIngressPortRangeRule.rb

@@ -6,7 +6,7 @@ require_relative 'base'
 class SecurityGroupIngressPortRangeRule < BaseRule
   def rule_text
     'Security Groups found ingress with port range instead of just a single ' \
-    'port'
+      'port'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/SecurityGroupMissingEgressRule.rb

@@ -6,7 +6,7 @@ require_relative 'base'
 class SecurityGroupMissingEgressRule < BaseRule
   def rule_text
     'Missing egress rule means all traffic is allowed outbound.  Make this ' \
-    'explicit if it is desired configuration'
+      'explicit if it is desired configuration'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/SecurityGroupRuleDescriptionRule.rb

@@ -8,8 +8,8 @@ require 'cfn-nag/util/blank'
 class SecurityGroupRuleDescriptionRule < BaseRule
   def rule_text
     'Security group rules without a description obscure their purpose and may '\
-    'lead to bad practices in ensuring they only allow traffic from the ports '\
-    'and sources/destinations required.'
+      'lead to bad practices in ensuring they only allow traffic from the ports '\
+      'and sources/destinations required.'
   end
 
   def rule_type

data/lib/cfn-nag/custom_rules/base.rb

@@ -19,9 +19,15 @@ class BaseRule
     logical_resource_ids = audit_impl(cfn_model)
     return if logical_resource_ids.empty?
 
+    violation(logical_resource_ids)
+  end
+
+  def violation(logical_resource_ids, line_numbers = [])
     Violation.new(id: rule_id,
+                  name: self.class.name,
                   type: rule_type,
                   message: rule_text,
-                  logical_resource_ids: logical_resource_ids)
+                  logical_resource_ids: logical_resource_ids,
+                  line_numbers: line_numbers)
   end
 end

data/lib/cfn-nag/deny_list_loader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+class DenyListLoader
+  def initialize(rules_registry)
+    @rules_registry = rules_registry
+  end
+
+  def load(deny_list_definition:)
+    raise 'Empty profile' if deny_list_definition.strip == ''
+
+    deny_list_ruleset = RuleIdSet.new
+
+    deny_list_hash = load_deny_list_yaml(deny_list_definition)
+    raise 'Deny list is malformed' unless deny_list_hash.is_a? Hash
+
+    rules_to_suppress = deny_list_hash.fetch('RulesToSuppress', {})
+    raise 'Missing RulesToSuppress key in deny list' if rules_to_suppress.empty?
+
+    rule_ids_to_suppress = rules_to_suppress.map { |rule| rule['id'] }
+    rule_ids_to_suppress.each do |rule_id|
+      check_valid_rule_id rule_id
+      deny_list_ruleset.add_rule rule_id
+    end
+
+    deny_list_ruleset
+  end
+
+  private
+
+  def load_deny_list_yaml(deny_list_definition)
+    YAML.safe_load(deny_list_definition)
+  rescue StandardError => yaml_parse_error
+    raise "YAML parse of deny list failed: #{yaml_parse_error}"
+  end
+
+  def check_valid_rule_id(rule_id)
+    return true unless @rules_registry.by_id(rule_id).nil?
+
+    raise "#{rule_id} is not a legal rule identifier from: #{@rules_registry.ids}"
+  end
+end

data/lib/cfn-nag/iam_complexity_metric/spcm.rb

@@ -11,8 +11,8 @@ class SPCM
                         parameter_values_path: nil,
                         condition_values_path: nil,
                         template_pattern: DEFAULT_TEMPLATE_PATTERN)
-    parameter_values_string = parameter_values_path.nil? ? nil : IO.read(parameter_values_path)
-    condition_values_string = condition_values_path.nil? ? nil : IO.read(condition_values_path)
+    parameter_values_string = parameter_values_path.nil? ? nil : File.read(parameter_values_path)
+    condition_values_string = condition_values_path.nil? ? nil : File.read(condition_values_path)
 
     templates = TemplateDiscovery.new.discover_templates(input_json_path: input_path,
                                                          template_pattern: template_pattern)
@@ -21,7 +21,7 @@ class SPCM
       aggregate_results << {
         filename: template,
         file_results: metric(
-          cloudformation_string: IO.read(template),
+          cloudformation_string: File.read(template),
           parameter_values_string: parameter_values_string,
           condition_values_string: condition_values_string
         )

data/lib/cfn-nag/result_view/json_results.rb

@@ -3,7 +3,7 @@
 require 'json'
 
 class JsonResults
-  def render(results)
+  def render(results, _rule_registry)
     hashified_results = results.each do |result|
       result[:file_results][:violations] = result[:file_results][:violations].map(&:to_h)
     end

data/lib/cfn-nag/result_view/sarif_results.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+
+class SarifResults
+  def render(results, rule_registry)
+    sarif_results = []
+    results.each do |file|
+      # For each file in the results, review the violations
+      file[:file_results][:violations].each do |violation|
+        # For each violation, generate a sarif result for each logical resource id in the violation
+        violation.logical_resource_ids.each_with_index do |_logical_resource_id, index|
+          sarif_results << sarif_result(file_name: file[:filename], violation: violation, index: index)
+        end
+      end
+    end
+
+    sarif_report = {
+      version: '2.1.0',
+      '$schema': 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json',
+      runs: [
+        tool: {
+          driver: driver(rule_registry.rules)
+        },
+        results: sarif_results
+      ]
+    }
+
+    puts JSON.pretty_generate(sarif_report)
+  end
+
+  # Generates a SARIF driver object, which describes the tool and the rules used
+  def driver(rules)
+    {
+      name: 'cfn_nag',
+      informationUri: 'https://github.com/stelligent/cfn_nag',
+      semanticVersion: CfnNagVersion::VERSION,
+      rules: rules.map do |rule_definition|
+        {
+          id: "CFN_NAG_#{rule_definition.id}",
+          name: rule_definition.name,
+          fullDescription: {
+            text: rule_definition.message
+          }
+        }
+      end
+    }
+  end
+
+  # Given a cfn_nag Violation object, and index, generates a SARIF result object for the finding
+  def sarif_result(file_name:, violation:, index:)
+    {
+      ruleId: "CFN_NAG_#{violation.id}",
+      level: sarif_level(violation.type),
+      message: {
+        text: violation.message
+      },
+      locations: [
+        {
+          physicalLocation: {
+            artifactLocation: {
+              uri: relative_path(file_name),
+              uriBaseId: '%SRCROOT%'
+            },
+            region: {
+              startLine: sarif_line_number(violation.line_numbers[index])
+            }
+          },
+          logicalLocations: [
+            {
+              name: violation.logical_resource_ids[index]
+            }
+          ]
+        }
+      ]
+    }
+  end
+
+  # Line number defaults to 1 unless provided with valid number
+  def sarif_line_number(line_number)
+    line_number.nil? || line_number.to_i < 1 ? 1 : line_number.to_i
+  end
+
+  def sarif_level(violation_type)
+    case violation_type
+    when RuleDefinition::WARNING
+      'warning'
+    else
+      'error'
+    end
+  end
+
+  def relative_path(file_name)
+    file_pathname = Pathname.new(file_name)
+
+    if file_pathname.relative?
+      file_pathname.to_s
+    else
+      file_pathname.relative_path_from(Pathname.pwd).to_s
+    end
+  end
+end

data/lib/cfn-nag/result_view/stdout_results.rb

@@ -24,7 +24,7 @@ class StdoutResults
     puts "Warnings count: #{Violation.count_warnings(violations)}"
   end
 
-  def render(results)
+  def render(results, _rule_definitions)
     results.each do |result|
       60.times { print '-' }
       puts "\n#{result[:filename]}"

data/lib/cfn-nag/rule_definition.rb

@@ -4,27 +4,30 @@ class RuleDefinition
   WARNING = 'WARN'
   FAILING_VIOLATION = 'FAIL'
 
-  attr_reader :id, :type, :message
+  attr_reader :id, :name, :type, :message
 
   def initialize(id:,
+                 name:,
                  type:,
                  message:)
     @id = id
+    @name = name
     @type = type
     @message = message
 
-    [@id, @type, @message].each do |required|
+    [@id, @type, @name, @message].each do |required|
       raise 'No parameters to Violation constructor can be nil' if required.nil?
     end
   end
 
   def to_s
-    "#{@id} #{@type} #{@message}"
+    "#{@id} #{name} #{@type} #{@message}"
   end
 
   def to_h
     {
       id: @id,
+      name: @name,
       type: @type,
       message: @message
     }

data/lib/cfn-nag/rule_registry.rb

@@ -43,6 +43,7 @@ class RuleRegistry
     if existing_def.nil?
       rule_definition = RuleDefinition.new(
         id: rule.rule_id,
+        name: rule_class.name,
         type: rule.rule_type,
         message: rule.rule_text
       )