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, VersionCheck, 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')]
88 config_checklist += [KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'is not off')]
89 config_checklist += [KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'is not off')]
90 config_checklist += [KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'is not off')]
91 config_checklist += [KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'is not off')]
93 # 2. prepare the parsed kconfig options
94 parsed_kconfig_options = OrderedDict()
95 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
96 parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
97 parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
98 parsed_kconfig_options['CONFIG_NAME_7'] = 'really_not_off'
99 parsed_kconfig_options['CONFIG_NAME_8'] = 'off'
100 parsed_kconfig_options['CONFIG_NAME_9'] = '0'
104 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
106 # 4. check that the results are correct
109 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
110 ["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""],
111 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: is not found"],
112 ["CONFIG_NAME_4", "kconfig", "is not set", "decision_4", "reason_4", "OK: is not found"],
113 ["CONFIG_NAME_5", "kconfig", "is present", "decision_5", "reason_5", "OK: is present"],
114 ["CONFIG_NAME_6", "kconfig", "is present", "decision_6", "reason_6", "FAIL: is not present"],
115 ["CONFIG_NAME_7", "kconfig", "is not off", "decision_7", "reason_7", "OK: is not off, \"really_not_off\""],
116 ["CONFIG_NAME_8", "kconfig", "is not off", "decision_8", "reason_8", "FAIL: is off"],
117 ["CONFIG_NAME_9", "kconfig", "is not off", "decision_9", "reason_9", "FAIL: is off, \"0\""],
118 ["CONFIG_NAME_10", "kconfig", "is not off", "decision_10", "reason_10", "FAIL: is off, not found"]]
121 def test_single_cmdline(self):
122 # 1. prepare the checklist
123 config_checklist = []
124 config_checklist += [CmdlineCheck('reason_1', 'decision_1', 'name_1', 'expected_1')]
125 config_checklist += [CmdlineCheck('reason_2', 'decision_2', 'name_2', 'expected_2')]
126 config_checklist += [CmdlineCheck('reason_3', 'decision_3', 'name_3', 'expected_3')]
127 config_checklist += [CmdlineCheck('reason_4', 'decision_4', 'name_4', 'is not set')]
128 config_checklist += [CmdlineCheck('reason_5', 'decision_5', 'name_5', 'is present')]
129 config_checklist += [CmdlineCheck('reason_6', 'decision_6', 'name_6', 'is present')]
130 config_checklist += [CmdlineCheck('reason_7', 'decision_7', 'name_7', 'is not off')]
131 config_checklist += [CmdlineCheck('reason_8', 'decision_8', 'name_8', 'is not off')]
132 config_checklist += [CmdlineCheck('reason_9', 'decision_9', 'name_9', 'is not off')]
133 config_checklist += [CmdlineCheck('reason_10', 'decision_10', 'name_10', 'is not off')]
135 # 2. prepare the parsed cmdline options
136 parsed_cmdline_options = OrderedDict()
137 parsed_cmdline_options['name_1'] = 'expected_1'
138 parsed_cmdline_options['name_2'] = 'UNexpected_2'
139 parsed_cmdline_options['name_5'] = ''
140 parsed_cmdline_options['name_7'] = ''
141 parsed_cmdline_options['name_8'] = 'off'
142 parsed_cmdline_options['name_9'] = '0'
146 self.run_engine(config_checklist, None, parsed_cmdline_options, None, result)
148 # 4. check that the results are correct
151 [["name_1", "cmdline", "expected_1", "decision_1", "reason_1", "OK"],
152 ["name_2", "cmdline", "expected_2", "decision_2", "reason_2", "FAIL: \"UNexpected_2\""],
153 ["name_3", "cmdline", "expected_3", "decision_3", "reason_3", "FAIL: is not found"],
154 ["name_4", "cmdline", "is not set", "decision_4", "reason_4", "OK: is not found"],
155 ["name_5", "cmdline", "is present", "decision_5", "reason_5", "OK: is present"],
156 ["name_6", "cmdline", "is present", "decision_6", "reason_6", "FAIL: is not present"],
157 ["name_7", "cmdline", "is not off", "decision_7", "reason_7", "OK: is not off, \"\""],
158 ["name_8", "cmdline", "is not off", "decision_8", "reason_8", "FAIL: is off"],
159 ["name_9", "cmdline", "is not off", "decision_9", "reason_9", "FAIL: is off, \"0\""],
160 ["name_10", "cmdline", "is not off", "decision_10", "reason_10", "FAIL: is off, not found"]]
164 # 1. prepare the checklist
165 config_checklist = []
166 config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
167 KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'))]
168 config_checklist += [OR(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
169 KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'))]
170 config_checklist += [OR(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
171 KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'))]
172 config_checklist += [OR(KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'),
173 KconfigCheck('reason_7', 'decision_7', 'NAME_7', 'is not set'))]
174 config_checklist += [OR(KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'expected_8'),
175 KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'is present'))]
176 config_checklist += [OR(KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'expected_10'),
177 KconfigCheck('reason_11', 'decision_11', 'NAME_11', 'is not off'))]
179 # 2. prepare the parsed kconfig options
180 parsed_kconfig_options = OrderedDict()
181 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
182 parsed_kconfig_options['CONFIG_NAME_2'] = 'UNexpected_2'
183 parsed_kconfig_options['CONFIG_NAME_3'] = 'UNexpected_3'
184 parsed_kconfig_options['CONFIG_NAME_4'] = 'expected_4'
185 parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
186 parsed_kconfig_options['CONFIG_NAME_6'] = 'UNexpected_6'
187 parsed_kconfig_options['CONFIG_NAME_9'] = 'UNexpected_9'
188 parsed_kconfig_options['CONFIG_NAME_11'] = 'really_not_off'
192 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
194 # 4. check that the results are correct
197 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
198 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "OK: CONFIG_NAME_4 is \"expected_4\""],
199 ["CONFIG_NAME_5", "kconfig", "expected_5", "decision_5", "reason_5", "FAIL: \"UNexpected_5\""],
200 ["CONFIG_NAME_6", "kconfig", "expected_6", "decision_6", "reason_6", "OK: CONFIG_NAME_7 is not found"],
201 ["CONFIG_NAME_8", "kconfig", "expected_8", "decision_8", "reason_8", "OK: CONFIG_NAME_9 is present"],
202 ["CONFIG_NAME_10", "kconfig", "expected_10", "decision_10", "reason_10", "OK: CONFIG_NAME_11 is not off"]]
206 # 1. prepare the checklist
207 config_checklist = []
208 config_checklist += [AND(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
209 KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'))]
210 config_checklist += [AND(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
211 KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'))]
212 config_checklist += [AND(KconfigCheck('reason_5', 'decision_5', 'NAME_5', 'expected_5'),
213 KconfigCheck('reason_6', 'decision_6', 'NAME_6', 'expected_6'))]
214 config_checklist += [AND(KconfigCheck('reason_8', 'decision_8', 'NAME_8', 'expected_8'),
215 KconfigCheck('reason_9', 'decision_9', 'NAME_9', 'is present'))]
216 config_checklist += [AND(KconfigCheck('reason_10', 'decision_10', 'NAME_10', 'expected_10'),
217 KconfigCheck('reason_11', 'decision_11', 'NAME_11', 'is not off'))]
218 config_checklist += [AND(KconfigCheck('reason_12', 'decision_12', 'NAME_12', 'expected_12'),
219 KconfigCheck('reason_13', 'decision_13', 'NAME_13', 'is not off'))]
221 # 2. prepare the parsed kconfig options
222 parsed_kconfig_options = OrderedDict()
223 parsed_kconfig_options['CONFIG_NAME_1'] = 'expected_1'
224 parsed_kconfig_options['CONFIG_NAME_2'] = 'expected_2'
225 parsed_kconfig_options['CONFIG_NAME_3'] = 'expected_3'
226 parsed_kconfig_options['CONFIG_NAME_4'] = 'UNexpected_4'
227 parsed_kconfig_options['CONFIG_NAME_5'] = 'UNexpected_5'
228 parsed_kconfig_options['CONFIG_NAME_6'] = 'expected_6'
229 parsed_kconfig_options['CONFIG_NAME_8'] = 'expected_8'
230 parsed_kconfig_options['CONFIG_NAME_10'] = 'expected_10'
231 parsed_kconfig_options['CONFIG_NAME_11'] = '0'
232 parsed_kconfig_options['CONFIG_NAME_12'] = 'expected_12'
236 self.run_engine(config_checklist, parsed_kconfig_options, None, None, result)
238 # 4. check that the results are correct
241 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK"],
242 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: CONFIG_NAME_4 is not \"expected_4\""],
243 ["CONFIG_NAME_5", "kconfig", "expected_5", "decision_5", "reason_5", "FAIL: \"UNexpected_5\""],
244 ["CONFIG_NAME_8", "kconfig", "expected_8", "decision_8", "reason_8", "FAIL: CONFIG_NAME_9 is not present"],
245 ["CONFIG_NAME_10", "kconfig", "expected_10", "decision_10", "reason_10", "FAIL: CONFIG_NAME_11 is off"],
246 ["CONFIG_NAME_12", "kconfig", "expected_12", "decision_12", "reason_12", "FAIL: CONFIG_NAME_13 is off, not found"]]
249 def test_version(self):
250 # 1. prepare the checklist
251 config_checklist = []
252 config_checklist += [OR(KconfigCheck('reason_1', 'decision_1', 'NAME_1', 'expected_1'),
253 VersionCheck((41, 101)))]
254 config_checklist += [AND(KconfigCheck('reason_2', 'decision_2', 'NAME_2', 'expected_2'),
255 VersionCheck((44, 1)))]
256 config_checklist += [AND(KconfigCheck('reason_3', 'decision_3', 'NAME_3', 'expected_3'),
257 VersionCheck((42, 44)))]
258 config_checklist += [OR(KconfigCheck('reason_4', 'decision_4', 'NAME_4', 'expected_4'),
259 VersionCheck((42, 43)))]
261 # 2. prepare the parsed kconfig options
262 parsed_kconfig_options = OrderedDict()
263 parsed_kconfig_options['CONFIG_NAME_2'] = 'expected_2'
264 parsed_kconfig_options['CONFIG_NAME_3'] = 'expected_3'
266 # 3. prepare the kernel version
267 kernel_version = (42, 43)
271 self.run_engine(config_checklist, parsed_kconfig_options, None, kernel_version, result)
273 # 5. check that the results are correct
276 [["CONFIG_NAME_1", "kconfig", "expected_1", "decision_1", "reason_1", "OK: version >= 41.101"],
277 ["CONFIG_NAME_2", "kconfig", "expected_2", "decision_2", "reason_2", "FAIL: version < 44.1"],
278 ["CONFIG_NAME_3", "kconfig", "expected_3", "decision_3", "reason_3", "FAIL: version < 42.44"],
279 ["CONFIG_NAME_4", "kconfig", "expected_4", "decision_4", "reason_4", "OK: version >= 42.43"]]