4 # This script helps me to check the Linux kernel Kconfig option list
5 # against my 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 # Please don't cry if my Python code looks like C.
13 # N.B Hardening command line parameters:
18 # kernel.kptr_restrict=1
21 # Mitigations of CPU vulnerabilities:
23 # mitigations=auto,nosmt
27 # spec_store_bypass_disable=on
31 # ? CONFIG_HARDEN_BRANCH_PREDICTOR
35 # N.B. Hardening sysctls:
36 # net.core.bpf_jit_harden=2
38 # vm.unprivileged_userfaultfd=0
39 # kernel.perf_event_paranoid=3
40 # kernel.yama.ptrace_scope=1
41 # kernel.unprivileged_bpf_disabled=1
44 from argparse import ArgumentParser
45 from collections import OrderedDict
49 debug_mode = False # set it to True to print the unknown options from the config
50 json_mode = False # if True, print results in JSON format
52 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
56 def __init__(self, name, expected, decision, reason):
58 self.expected = expected
59 self.decision = decision
65 if self.expected == self.state:
67 elif self.state is None:
68 if self.expected == 'is not set':
69 self.result = 'OK: not found'
71 self.result = 'FAIL: not found'
73 self.result = 'FAIL: "' + self.state + '"'
75 if self.result.startswith('OK'):
76 return True, self.result
78 return False, self.result
81 return '{} = {}'.format(self.name, self.state)
84 class ComplexOptCheck:
85 def __init__(self, *opts):
91 return self.opts[0].name
95 return self.opts[0].expected
99 return self.opts[0].state
103 return self.opts[0].decision
107 return self.opts[0].reason
110 class OR(ComplexOptCheck):
111 # self.opts[0] is the option which this OR-check is about.
113 # OR(<X_is_hardened>, <X_is_disabled>)
114 # OR(<X_is_hardened>, <X_is_hardened_old>)
118 sys.exit('[!] ERROR: invalid OR check')
120 for i, opt in enumerate(self.opts):
121 ret, msg = opt.check()
124 self.result = opt.result
126 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
127 return True, self.result
128 self.result = self.opts[0].result
129 return False, self.result
132 class AND(ComplexOptCheck):
133 # self.opts[0] is the option which this AND-check is about.
134 # Use case: AND(<suboption>, <main_option>)
135 # Suboption is not checked if checking of the main_option is failed.
138 for i, opt in reversed(list(enumerate(self.opts))):
139 ret, msg = opt.check()
141 self.result = opt.result
142 return ret, self.result
144 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
145 return False, self.result
147 sys.exit('[!] ERROR: invalid AND check')
150 def detect_arch(fname):
151 with open(fname, 'r') as f:
152 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
156 print('[+] Trying to detect architecture in "{}"...'.format(fname))
157 for line in f.readlines():
158 if arch_pattern.match(line):
159 option, value = line[7:].split('=', 1)
160 if option in supported_archs:
164 return None, 'more than one supported architecture is detected'
166 return None, 'failed to detect architecture'
171 def construct_checklist(checklist, arch):
172 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
173 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
175 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
176 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
177 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
178 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
179 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
180 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
181 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
182 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
183 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
184 if debug_mode or arch == 'X86_64':
185 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
186 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
187 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
188 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
189 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
190 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
191 checklist.append(OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection'))
192 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
193 if debug_mode or arch == 'ARM64':
194 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
195 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
196 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
197 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
198 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
199 if debug_mode or arch == 'ARM':
200 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'self_protection'))
201 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
202 if debug_mode or arch == 'ARM64' or arch == 'ARM':
203 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'))
205 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
206 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
207 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
208 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
209 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
210 checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
211 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
212 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'kspp', 'self_protection'))
213 randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
214 checklist.append(randstruct_is_set)
215 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
216 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
217 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
218 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
219 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
220 page_poisoning_is_set = OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection')
221 checklist.append(page_poisoning_is_set)
222 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
223 checklist.append(hardened_usercopy_is_set)
224 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
225 hardened_usercopy_is_set))
226 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
228 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
230 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
232 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
233 modules_not_set)) # refers to LOCK_DOWN_KERNEL
234 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
235 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
236 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'kspp', 'self_protection'))
237 if debug_mode or arch == 'X86_32':
238 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
239 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
240 if debug_mode or arch == 'ARM64':
241 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
242 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'kspp', 'self_protection'))
243 if debug_mode or arch == 'ARM64' or arch == 'ARM':
244 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
245 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
247 checklist.append(OptCheck('LOCK_DOWN_KERNEL', 'y', 'clipos', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
248 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
249 checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
250 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
251 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
252 checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
254 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
255 stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'clipos', 'self_protection')
256 checklist.append(stackleak_is_set)
257 checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
259 checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
261 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
262 checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
263 checklist.append(OptCheck('MICROCODE', 'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
264 iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
265 checklist.append(iommu_support_is_set)
266 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'clipos', 'self_protection'), \
267 iommu_support_is_set))
268 checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
269 iommu_support_is_set))
270 checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
271 iommu_support_is_set))
273 checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'my', 'self_protection'), \
274 OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
275 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
276 checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'self_protection')) # needs userspace support
277 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
278 checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY', 'is not set', 'my', 'self_protection'), \
279 page_poisoning_is_set))
280 checklist.append(AND(OptCheck('PAGE_POISONING_ZERO', 'is not set', 'my', 'self_protection'), \
281 page_poisoning_is_set))
282 if debug_mode or arch == 'X86_64':
283 checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'my', 'self_protection'), \
284 iommu_support_is_set))
285 checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
286 iommu_support_is_set))
287 if debug_mode or arch == 'X86_32':
288 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
289 if debug_mode or arch == 'ARM':
290 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'my', 'self_protection'))
292 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
293 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
294 if debug_mode or arch == 'ARM':
295 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
296 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
298 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
299 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
300 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
301 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
302 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
304 checklist.append(modules_not_set)
305 checklist.append(devmem_not_set)
306 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
307 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
308 if debug_mode or arch == 'ARM':
309 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
310 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
311 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
312 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
313 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface'))
314 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
315 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
316 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
317 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
318 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
319 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
320 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
321 if debug_mode or arch == 'X86_64':
322 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
323 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
324 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
325 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
326 if debug_mode or arch == 'ARM':
327 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
329 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
330 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
331 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
332 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
333 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
334 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
335 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
336 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface'))
337 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
338 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
339 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
340 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
341 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
342 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
343 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
344 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
345 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
346 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
348 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
349 checklist.append(OptCheck('ACPI_APEI_EINJ', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
350 checklist.append(OptCheck('PROFILING', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
351 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
352 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
354 checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
355 checklist.append(OptCheck('IKCONFIG', 'is not set', 'clipos', 'cut_attack_surface'))
356 checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
357 checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
358 checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
359 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
360 checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
361 checklist.append(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'))
363 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
364 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
365 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
366 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
367 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface'))
368 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
369 if debug_mode or arch == 'X86_32':
370 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
372 if debug_mode or arch == 'ARM64':
373 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_protection'))
374 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
375 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_protection'))
376 if debug_mode or arch == 'X86_32' or arch == 'ARM':
377 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_protection'))
379 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
382 def print_checklist(checklist, with_results):
386 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
390 print(json.dumps(opts))
394 print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
397 print('||{:^28}'.format('check result'), end='')
401 print('=' * sep_line_len)
403 for opt in checklist:
404 print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
406 print('||{:^28}'.format(opt.result), end='')
411 def get_option_state(options, name):
412 return options.get(name, None)
415 def perform_checks(checklist, parsed_options):
416 for opt in checklist:
417 if hasattr(opt, 'opts'):
419 o.state = get_option_state(parsed_options, o.name)
421 opt.state = get_option_state(parsed_options, opt.name)
425 def check_config_file(checklist, fname):
426 with open(fname, 'r') as f:
427 parsed_options = OrderedDict()
428 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
429 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
432 print('[+] Checking "{}" against hardening preferences...'.format(fname))
433 for line in f.readlines():
438 if opt_is_on.match(line):
439 option, value = line[7:].split('=', 1)
440 elif opt_is_off.match(line):
441 option, value = line[9:].split(' ', 1)
442 if value != 'is not set':
443 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
445 if option in parsed_options:
446 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
448 if option is not None:
449 parsed_options[option] = value
451 perform_checks(checklist, parsed_options)
454 known_options = [opt.name for opt in checklist]
455 for option, value in parsed_options.items():
456 if option not in known_options:
457 print("DEBUG: dunno about option {} ({})".format(option, value))
459 print_checklist(checklist, True)
462 if __name__ == '__main__':
463 config_checklist = []
465 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
466 parser.add_argument('-p', '--print', choices=supported_archs,
467 help='print hardening preferences for selected architecture')
468 parser.add_argument('-c', '--config',
469 help='check the config_file against these preferences')
470 parser.add_argument('--debug', action='store_true',
471 help='enable internal debug mode')
472 parser.add_argument('--json', action='store_true',
473 help='print results in JSON format')
474 args = parser.parse_args()
480 if debug_mode and json_mode:
481 sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
484 arch, msg = detect_arch(args.config)
486 sys.exit('[!] ERROR: {}'.format(msg))
488 print('[+] Detected architecture: {}'.format(arch))
490 construct_checklist(config_checklist, arch)
491 check_config_file(config_checklist, args.config)
492 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
493 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
497 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
502 construct_checklist(config_checklist, arch)
504 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
505 print_checklist(config_checklist, False)