4 This tool helps me to check Linux kernel options against
5 my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
6 Let the computers do their job!
8 Author: Alexander Popov <alex.popov@linux.com>
10 This module performs unit-testing of the kconfig-hardened-check engine.
13 # pylint: disable=missing-function-docstring,line-too-long
16 from collections import OrderedDict
18 from .engine import KconfigCheck, CmdlineCheck, OR, AND, populate_with_data, perform_checks
21 class TestEngine(unittest.TestCase):
23 Example test scenario:
25 # 1. prepare the checklist
27 config_checklist += [KconfigCheck('reason_1', 'decision_1', 'KCONFIG_NAME', 'expected_1')]
28 config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'cmdline_name', 'expected_2')]
30 # 2. prepare the parsed kconfig options
31 parsed_kconfig_options = OrderedDict()
32 parsed_kconfig_options['CONFIG_KCONFIG_NAME'] = 'UNexpected_1'
34 # 3. prepare the parsed cmdline options
35 parsed_cmdline_options = OrderedDict()
36 parsed_cmdline_options['cmdline_name'] = 'expected_2'
38 # 4. prepare the kernel version
39 kernel_version = (42, 43)
43 self.run_engine(config_checklist,
44 parsed_kconfig_options, parsed_cmdline_options, kernel_version,
47 # 6. check that the results are correct
48 # self.assertEqual(...
52 def run_engine(checklist,
53 parsed_kconfig_options, parsed_cmdline_options, kernel_version,
55 # populate the checklist with data
56 if parsed_kconfig_options:
57 populate_with_data(checklist, parsed_kconfig_options, 'kconfig')
58 if parsed_cmdline_options:
59 populate_with_data(checklist, parsed_cmdline_options, 'cmdline')
61 populate_with_data(checklist, kernel_version, 'version')
63 # now everything is ready, perform the checks
64 perform_checks(checklist)
66 # print the table with the results
69 opt.table_print(None, True) # default mode, with_results
72 # print the results in JSON
75 result.append(opt.json_dump(True)) # with_results
76 print(json.dumps(result))
79 def test_single_kconfig(self):
80 # 1. prepare the checklist
82 config_checklist += [KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1')]
83 config_checklist += [KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2')]
84 config_checklist += [KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3')]
85 config_checklist += [KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'is not set')]
86 config_checklist += [KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'is present')]
87 config_checklist += [KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'is present')]
89 # 2. prepare the parsed kconfig options
90 parsed_kconfig_options = OrderedDict()
91 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
92 parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
93 parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
97 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
99 # 4. check that the results are correct
102 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
103 ["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""],
104 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: is not found"],
105 ["CONFIG_NAME_4", "kconfig", "is not set", "decision_4", "reason_4", "OK: is not found"],
106 ["CONFIG_NAME_5", "kconfig", "is present", "decision_5", "reason_5", "OK: is present"],
107 ["CONFIG_NAME_6", "kconfig", "is present", "decision_6", "reason_6", "FAIL: is not present"]]
110 def test_single_cmdline(self):
111 # 1. prepare the checklist
112 config_checklist = []
113 config_checklist += [CmdlineCheck('reason_1', 'decision_1', 'name_1', 'expected_1')]
114 config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'name_2', 'expected_2')]
115 config_checklist += [CmdlineCheck('reason_3', 'decision_3', 'name_3', 'expected_3')]
116 config_checklist += [CmdlineCheck('reason_4', 'decision_4', 'name_4', 'is not set')]
117 config_checklist += [CmdlineCheck('reason_5', 'decision_5', 'name_5', 'is present')]
118 config_checklist += [CmdlineCheck('reason_6', 'decision_6', 'name_6', 'is present')]
120 # 2. prepare the parsed cmdline options
121 parsed_cmdline_options = OrderedDict()
122 parsed_cmdline_options['name_1'] = 'expected_1'
123 parsed_cmdline_options['name_2'] = 'UNexpected_2'
124 parsed_cmdline_options['name_5'] = ''
128 self.run_engine(config_checklist, None, parsed_cmdline_options, None, result)
130 # 4. check that the results are correct
133 [["name_1", "cmdline", "expected_1", "decision_1", "reason_1", "OK"],
134 ["name_2", "cmdline", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""],
135 ["name_3", "cmdline", "expected_3", "decision_3", "reason_3", "FAIL: is not found"],
136 ["name_4", "cmdline", "is not set", "decision_4", "reason_4", "OK: is not found"],
137 ["name_5", "cmdline", "is present", "decision_5", "reason_5", "OK: is present"],
138 ["name_6", "cmdline", "is present", "decision_6", "reason_6", "FAIL: is not present"]]
142 # 1. prepare the checklist
143 config_checklist = []
144 config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
145 KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'))]
146 config_checklist += [OR(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
147 KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'))]
148 config_checklist += [OR(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
149 KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'))]
150 config_checklist += [OR(KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'),
151 KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'is not set'))]
153 # 2. prepare the parsed kconfig options
154 parsed_kconfig_options = OrderedDict()
155 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
156 parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
157 parsed_kconfig_options['CONFIG_NAME_3'] = 'UNexpected_3'
158 parsed_kconfig_options['CONFIG_NAME_4'] = 'expected_4'
159 parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
160 parsed_kconfig_options['CONFIG_NAME_6'] = 'UNexpected_6'
164 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
166 # 4. check that the results are correct
169 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
170 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "OK: CONFIG_NAME_4 is \"expected_4\""],
171 ["CONFIG_NAME_5", "kconfig", "expected_5", "decision_5", "reason_5", "FAIL: \"UNexpected_5\""],
172 ["CONFIG_NAME_6", "kconfig", "expected_6", "decision_6", "reason_6", "OK: CONFIG_NAME_7 is not found"]]
176 # 1. prepare the checklist
177 config_checklist = []
178 config_checklist += [AND(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
179 KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'))]
180 config_checklist += [AND(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
181 KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'))]
182 config_checklist += [AND(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
183 KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'))]
185 # 2. prepare the parsed kconfig options
186 parsed_kconfig_options = OrderedDict()
187 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
188 parsed_kconfig_options['CONFIG_NAME_2'] = 'expected_2'
189 parsed_kconfig_options['CONFIG_NAME_3'] = 'expected_3'
190 parsed_kconfig_options['CONFIG_NAME_4'] = 'UNexpected_4'
191 parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
192 parsed_kconfig_options['CONFIG_NAME_6'] = 'expected_6'
196 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
198 # 4. check that the results are correct
201 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
202 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: CONFIG_NAME_4 is not \"expected_4\""],
203 ["CONFIG_NAME_5", "kconfig", "expected_5", "decision_5", "reason_5", "FAIL: \"UNexpected_5\""]]