Class: CfnNag
- Inherits:
-
Object
show all
- Includes:
- Rule
- Defined in:
- lib/cfn_nag.rb
Instance Attribute Summary
Attributes included from Rule
#input_json
Class Method Summary
collapse
Instance Method Summary
collapse
Methods included from Rule
#add_violation, #assertion, count_failures, count_warnings, empty?, #fatal_assertion, #fatal_violation, #raw_fatal_assertion, #raw_fatal_violation, #resources, #resources_by_type, #violation, #warning
Constructor Details
#initialize(profile_definition: nil) ⇒ CfnNag
Returns a new instance of CfnNag.
14
15
16
17
18
19
20
|
# File 'lib/cfn_nag.rb', line 14
def initialize(profile_definition: nil)
@warning_registry = []
@violation_registry = []
@rule_registry = RuleRegistry.new
@custom_rule_loader = CustomRuleLoader.new(@rule_registry)
@profile_definition = profile_definition
end
|
Class Method Details
86
87
88
89
90
91
92
93
94
95
|
# File 'lib/cfn_nag.rb', line 86
def self.configure_logging(opts)
logger = Logging.logger['log']
if opts[:debug]
logger.level = :debug
else
logger.level = :info
end
logger.add_appenders Logging.appenders.stdout
end
|
Instance Method Details
#audit(input_json_path:, rule_directories: [], output_format: 'txt') ⇒ Object
53
54
55
56
57
58
59
60
61
62
63
|
# File 'lib/cfn_nag.rb', line 53
def audit(input_json_path:,
rule_directories: [],
output_format:'txt')
(rule_directories)
aggregate_results = audit_results input_json_path: input_json_path,
output_format: output_format,
rule_directories: rule_directories.flatten
aggregate_results.inject(0) { |total_failure_count, results| total_failure_count + results[:file_results][:failure_count] }
end
|
#audit_results(input_json_path:, output_format: 'txt', rule_directories: []) ⇒ Object
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# File 'lib/cfn_nag.rb', line 65
def audit_results(input_json_path:,
output_format:'txt',
rule_directories: [])
templates = discover_templates(input_json_path)
aggregate_results = []
templates.each do |template|
aggregate_results << {
filename: template,
file_results: audit_file(input_json_path: template,
rule_directories: rule_directories)
}
end
render_results(aggregate_results: aggregate_results,
output_format: output_format)
aggregate_results
end
|
#audit_template(input_json:, rule_directories: []) ⇒ Object
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# File 'lib/cfn_nag.rb', line 97
def audit_template(input_json:,
rule_directories: [])
@stop_processing = false
@violations = []
unless legal_json?(input_json)
@violations << Violation.new(id: 'FATAL',
type: Violation::FAILING_VIOLATION,
message: 'not even legit JSON',
violating_code: input_json)
@stop_processing = true
end
generic_json_rules(input_json, rule_directories) unless @stop_processing == true
@violations += custom_rules input_json unless @stop_processing == true
@violations = filter_violations_by_profile @violations unless @stop_processing == true
{
failure_count: Rule::count_failures(@violations),
violations: @violations
}
end
|
#dump_rules(rule_directories: []) ⇒ Object
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# File 'lib/cfn_nag.rb', line 22
def dump_rules(rule_directories: [])
(rule_directories)
dummy_cfn = <<-END
{
"Resources": {
"resource1": {
"Type" : "AWS::EC2::DHCPOptions",
"Properties": {
"DomainNameServers" : [ "10.0.0.1" ]
}
}
}
}
END
Tempfile.open('tempfile') do |dummy_cfn_template|
dummy_cfn_template.write dummy_cfn
dummy_cfn_template.rewind
audit_file(input_json_path: dummy_cfn_template.path,
rule_directories: rule_directories)
end
profile = nil
unless @profile_definition.nil?
profile = ProfileLoader.new(@rule_registry).load(profile_definition: @profile_definition)
end
RulesView.new.emit(@rule_registry, profile)
end
|