4 # This tool 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:
16 # page_alloc.shuffle=1
17 # iommu=force (does it help against DMA attacks?)
18 # page_poison=1 (if enabled)
23 # Mitigations of CPU vulnerabilities:
25 # mitigations=auto,nosmt
29 # spec_store_bypass_disable=on
37 # N.B. Hardening sysctls:
38 # kernel.kptr_restrict=2
39 # kernel.dmesg_restrict=1
40 # kernel.perf_event_paranoid=3
41 # kernel.kexec_load_disabled=1
42 # kernel.yama.ptrace_scope=3
43 # user.max_user_namespaces=0
44 # what about bpf_jit_enable?
45 # kernel.unprivileged_bpf_disabled=1
46 # net.core.bpf_jit_harden=2
48 # vm.unprivileged_userfaultfd=0
50 # dev.tty.ldisc_autoload=0
51 # fs.protected_symlinks=1
52 # fs.protected_hardlinks=1
53 # fs.protected_fifos=2
54 # fs.protected_regular=2
56 # kernel.modules_disabled=1
59 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
60 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
64 from argparse import ArgumentParser
65 from collections import OrderedDict
68 from .__about__ import __version__
72 def __init__(self, reason, decision, name, expected):
74 self.expected = expected
75 self.decision = decision
81 if self.expected == self.state:
83 elif self.state is None:
84 if self.expected == 'is not set':
85 self.result = 'OK: not found'
87 self.result = 'FAIL: not found'
89 self.result = 'FAIL: "' + self.state + '"'
91 if self.result.startswith('OK'):
95 def table_print(self, _mode, with_results):
96 print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(self.name, self.expected, self.decision, self.reason), end='')
98 print('| {}'.format(self.result), end='')
102 def __init__(self, ver_expected):
103 self.ver_expected = ver_expected
108 if self.ver[0] > self.ver_expected[0]:
109 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
111 if self.ver[0] < self.ver_expected[0]:
112 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
114 if self.ver[1] >= self.ver_expected[1]:
115 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
117 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
120 def table_print(self, _mode, with_results):
121 ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
122 print('{:<91}'.format(ver_req), end='')
124 print('| {}'.format(self.result), end='')
128 def __init__(self, name):
134 if self.state is None:
135 self.result = 'FAIL: not present'
137 self.result = 'OK: is present'
140 def table_print(self, _mode, with_results):
141 print('CONFIG_{:<84}'.format(self.name + ' is present'), end='')
143 print('| {}'.format(self.result), end='')
146 class ComplexOptCheck:
147 def __init__(self, *opts):
150 sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
151 if not isinstance(opts[0], OptCheck):
152 sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
157 return self.opts[0].name
161 return self.opts[0].expected
165 return self.opts[0].decision
169 return self.opts[0].reason
171 def table_print(self, mode, with_results):
172 if mode == 'verbose':
173 print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
175 print('| {}'.format(self.result), end='')
178 o.table_print(mode, with_results)
181 o.table_print(mode, False)
183 print('| {}'.format(self.result), end='')
186 class OR(ComplexOptCheck):
187 # self.opts[0] is the option that this OR-check is about.
189 # OR(<X_is_hardened>, <X_is_disabled>)
190 # OR(<X_is_hardened>, <old_X_is_hardened>)
194 sys.exit('[!] ERROR: invalid OR check')
196 for i, opt in enumerate(self.opts):
199 if opt.result != 'OK' or i == 0:
200 # Preserve additional explanation of this OK result.
201 # Simple OK is enough only for the main option that
202 # this OR-check is about.
203 self.result = opt.result
205 # Simple OK is not enough for additional checks.
206 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
208 self.result = self.opts[0].result
212 class AND(ComplexOptCheck):
213 # self.opts[0] is the option that this AND-check is about.
215 # AND(<suboption>, <main_option>)
216 # Suboption is not checked if checking of the main_option is failed.
217 # AND(<X_is_disabled>, <old_X_is_disabled>)
220 for i, opt in reversed(list(enumerate(self.opts))):
223 self.result = opt.result
226 # This FAIL is caused by additional checks,
227 # and not by the main option that this AND-check is about.
228 # Describe the reason of the FAIL.
229 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
230 self.result = 'FAIL: CONFIG_{} not "{}"'.format(opt.name, opt.expected)
231 elif opt.result == 'FAIL: not present':
232 self.result = 'FAIL: CONFIG_{} not present'.format(opt.name)
234 # This FAIL message is self-explaining.
235 self.result = opt.result
238 sys.exit('[!] ERROR: invalid AND check')
241 def detect_arch(fname, archs):
242 with open(fname, 'r') as f:
243 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
245 for line in f.readlines():
246 if arch_pattern.match(line):
247 option, _ = line[7:].split('=', 1)
252 return None, 'more than one supported architecture is detected'
254 return None, 'failed to detect architecture'
258 def detect_version(fname):
259 with open(fname, 'r') as f:
260 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
261 for line in f.readlines():
262 if ver_pattern.match(line):
266 ver_numbers = ver_str.split('.')
267 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
268 msg = 'failed to parse the version "' + ver_str + '"'
270 return (int(ver_numbers[0]), int(ver_numbers[1])), None
271 return None, 'no kernel version detected'
274 def construct_checklist(l, arch):
275 modules_not_set = OptCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
276 devmem_not_set = OptCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
278 # 'self_protection', 'defconfig'
279 l += [OptCheck('self_protection', 'defconfig', 'BUG', 'y')]
280 l += [OptCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
281 l += [OptCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
282 l += [OR(OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
283 OptCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
284 l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
285 OptCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
286 l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
287 OptCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
288 modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
289 l += [OR(OptCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
290 VerCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
291 iommu_support_is_set = OptCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
292 l += [iommu_support_is_set] # is needed for mitigating DMA attacks
293 if arch in ('X86_64', 'X86_32'):
294 l += [OptCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
295 l += [OptCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
296 l += [OptCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
297 l += [OptCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
298 l += [OR(OptCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
299 OptCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
301 l += [OptCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
302 l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
303 l += [AND(OptCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
304 iommu_support_is_set)]
305 l += [AND(OptCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
306 iommu_support_is_set)]
308 l += [OptCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
309 l += [OptCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
310 l += [OR(OptCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
311 AND(OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
312 VerCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
313 l += [OptCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
314 l += [OptCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
315 if arch in ('X86_64', 'ARM64'):
316 l += [OptCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
317 if arch in ('X86_64', 'ARM64', 'X86_32'):
318 l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
319 l += [OptCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
321 l += [OptCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
322 l += [OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
323 if arch in ('ARM64', 'ARM'):
324 l += [OptCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
326 # 'self_protection', 'kspp'
327 l += [OptCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
328 l += [OptCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
329 l += [OptCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
330 l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
331 l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
332 l += [OptCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
333 l += [OptCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
334 l += [OptCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
335 l += [OptCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
336 l += [OptCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
337 l += [OptCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
338 l += [OptCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
339 l += [OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
340 randstruct_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
341 l += [randstruct_is_set]
342 hardened_usercopy_is_set = OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
343 l += [hardened_usercopy_is_set]
344 l += [AND(OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
345 hardened_usercopy_is_set)]
346 l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
348 l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
350 l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
352 l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
353 modules_not_set)] # refers to LOCKDOWN
354 l += [OR(OptCheck('self_protection', 'kspp', 'INIT_STACK_ALL', 'y'),
355 OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
356 l += [OR(OptCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
357 OptCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))] # before v5.3
358 if arch in ('X86_64', 'ARM64', 'X86_32'):
359 stackleak_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
360 l += [stackleak_is_set]
361 if arch in ('X86_64', 'X86_32'):
362 l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
364 l += [OptCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
365 l += [OptCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
366 l += [OptCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
368 l += [OptCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
369 if arch in ('ARM64', 'ARM'):
370 l += [OptCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
371 l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
373 # 'self_protection', 'clipos'
374 l += [OptCheck('self_protection', 'clipos', 'SECURITY_DMESG_RESTRICT', 'y')]
375 l += [OptCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
376 l += [OptCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
377 l += [OptCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y')]
378 l += [OptCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
379 l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
380 l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
381 l += [AND(OptCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
383 if arch in ('X86_64', 'ARM64', 'X86_32'):
384 l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
386 l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
388 if arch in ('X86_64', 'X86_32'):
389 l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
390 iommu_support_is_set)]
391 l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
392 iommu_support_is_set)]
394 l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
395 iommu_support_is_set)]
397 # 'self_protection', 'my'
398 l += [OptCheck('self_protection', 'my', 'SLUB_DEBUG_ON', 'y')] # TODO: is it better to set that via kernel cmd?
399 l += [OptCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y')] # needs userspace support (systemd)
401 l += [AND(OptCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
402 iommu_support_is_set)]
405 if arch in ('X86_64', 'ARM64', 'X86_32'):
406 l += [OptCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
408 l += [OptCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
409 l += [OptCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
410 l += [OR(OptCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
411 OptCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
412 l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
413 l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
414 l += [OptCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
415 l += [OptCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
416 loadpin_is_set = OptCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
417 l += [loadpin_is_set] # needs userspace support
418 l += [AND(OptCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
421 # 'cut_attack_surface', 'defconfig'
422 l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
423 l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
424 if arch in ('X86_64', 'ARM64', 'X86_32'):
425 l += [OR(OptCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
426 devmem_not_set)] # refers to LOCKDOWN
428 # 'cut_attack_surface', 'kspp'
429 l += [OptCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
430 l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
431 l += [OptCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
432 l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
433 l += [OptCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
434 l += [OptCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
435 l += [OptCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
436 l += [OptCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
437 l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
438 l += [OptCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
439 l += [OptCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
440 l += [OptCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
441 l += [OptCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
442 l += [OptCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
443 l += [modules_not_set]
444 l += [devmem_not_set]
445 l += [OR(OptCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
446 devmem_not_set)] # refers to LOCKDOWN
448 l += [OR(OptCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
449 devmem_not_set)] # refers to LOCKDOWN
451 l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
453 # 'cut_attack_surface', 'grsecurity'
454 l += [OptCheck('cut_attack_surface', 'grsecurity', 'ZSMALLOC_STAT', 'is not set')]
455 l += [OptCheck('cut_attack_surface', 'grsecurity', 'PAGE_OWNER', 'is not set')]
456 l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_KMEMLEAK', 'is not set')]
457 l += [OptCheck('cut_attack_surface', 'grsecurity', 'BINFMT_AOUT', 'is not set')]
458 l += [OptCheck('cut_attack_surface', 'grsecurity', 'KPROBES', 'is not set')] # refers to LOCKDOWN
459 l += [OptCheck('cut_attack_surface', 'grsecurity', 'UPROBES', 'is not set')]
460 l += [OptCheck('cut_attack_surface', 'grsecurity', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
461 l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_VMCORE', 'is not set')]
462 l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_PAGE_MONITOR', 'is not set')]
463 l += [OptCheck('cut_attack_surface', 'grsecurity', 'USELIB', 'is not set')]
464 l += [OptCheck('cut_attack_surface', 'grsecurity', 'CHECKPOINT_RESTORE', 'is not set')]
465 l += [OptCheck('cut_attack_surface', 'grsecurity', 'USERFAULTFD', 'is not set')]
466 l += [OptCheck('cut_attack_surface', 'grsecurity', 'HWPOISON_INJECT', 'is not set')]
467 l += [OptCheck('cut_attack_surface', 'grsecurity', 'MEM_SOFT_DIRTY', 'is not set')]
468 l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
469 l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
470 l += [OptCheck('cut_attack_surface', 'grsecurity', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
471 l += [AND(OptCheck('cut_attack_surface', 'grsecurity', 'X86_PTDUMP', 'is not set'),
472 OptCheck('cut_attack_surface', 'my', 'PTDUMP_DEBUGFS', 'is not set'))]
474 # 'cut_attack_surface', 'maintainer'
475 l += [OptCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')]
476 l += [OptCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')]
477 l += [OptCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')]
479 # 'cut_attack_surface', 'grapheneos'
480 l += [OptCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
482 # 'cut_attack_surface', 'clipos'
483 l += [OptCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
484 l += [OptCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
485 # l += [OptCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
486 l += [OptCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
487 l += [OptCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
488 l += [OptCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
489 l += [OptCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
490 l += [OptCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
491 l += [OptCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
492 l += [OptCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
493 l += [OptCheck('cut_attack_surface', 'clipos', 'IO_URING', 'is not set')]
494 l += [OptCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
495 l += [OptCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
496 l += [OptCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
497 l += [AND(OptCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
498 PresenceCheck('LDISC_AUTOLOAD'))]
499 if arch in ('X86_64', 'X86_32'):
500 l += [OptCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
502 # 'cut_attack_surface', 'lockdown'
503 l += [OptCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
504 l += [OptCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set')] # refers to LOCKDOWN
505 l += [OptCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
507 # 'cut_attack_surface', 'my'
508 l += [OptCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
509 l += [OptCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
510 l += [OptCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
511 l += [OptCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
512 l += [OptCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
513 l += [OptCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
514 l += [OptCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
516 # 'userspace_hardening'
517 if arch in ('X86_64', 'ARM64', 'X86_32'):
518 l += [OptCheck('userspace_hardening', 'defconfig', 'INTEGRITY', 'y')]
520 l += [OptCheck('userspace_hardening', 'my', 'INTEGRITY', 'y')]
521 if arch in ('ARM', 'X86_32'):
522 l += [OptCheck('userspace_hardening', 'defconfig', 'VMSPLIT_3G', 'y')]
523 if arch in ('X86_64', 'ARM64'):
524 l += [OptCheck('userspace_hardening', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
525 if arch in ('X86_32', 'ARM'):
526 l += [OptCheck('userspace_hardening', 'my', 'ARCH_MMAP_RND_BITS', '16')]
528 # l += [OptCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
531 def print_unknown_options(checklist, parsed_options):
533 for opt in checklist:
534 if hasattr(opt, 'opts'):
536 if hasattr(o, 'name'):
537 known_options.append(o.name)
539 known_options.append(opt.name)
540 for option, value in parsed_options.items():
541 if option not in known_options:
542 print('[?] No rule for option {} ({})'.format(option, value))
545 def print_checklist(mode, checklist, with_results):
549 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
553 print(json.dumps(opts))
560 print('=' * sep_line_len)
561 print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
563 print('| {}'.format('check result'), end='')
565 print('=' * sep_line_len)
568 for opt in checklist:
570 if mode == 'show_ok':
571 if not opt.result.startswith('OK'):
573 if mode == 'show_fail':
574 if not opt.result.startswith('FAIL'):
576 opt.table_print(mode, with_results)
578 if mode == 'verbose':
579 print('-' * sep_line_len)
584 fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
586 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
588 if mode == 'show_ok':
589 fail_suppressed = ' (suppressed in output)'
590 if mode == 'show_fail':
591 ok_suppressed = ' (suppressed in output)'
593 print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
596 def perform_check(opt, parsed_options, kernel_version):
597 if hasattr(opt, 'opts'):
598 # prepare ComplexOptCheck
600 if hasattr(o, 'opts'):
601 # Recursion for nested ComplexOptChecks
602 perform_check(o, parsed_options, kernel_version)
603 if hasattr(o, 'state'):
604 o.state = parsed_options.get(o.name, None)
605 if hasattr(o, 'ver'):
606 o.ver = kernel_version
608 # prepare simple check, opt.state is mandatory
609 if not hasattr(opt, 'state'):
610 sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
611 opt.state = parsed_options.get(opt.name, None)
615 def perform_checks(checklist, parsed_options, kernel_version):
616 for opt in checklist:
617 perform_check(opt, parsed_options, kernel_version)
620 def parse_config_file(parsed_options, fname):
621 with open(fname, 'r') as f:
622 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
623 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
625 for line in f.readlines():
630 if opt_is_on.match(line):
631 option, value = line[7:].split('=', 1)
632 elif opt_is_off.match(line):
633 option, value = line[9:].split(' ', 1)
634 if value != 'is not set':
635 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
637 if option in parsed_options:
638 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
641 parsed_options[option] = value
643 return parsed_options
649 # - reporting about unknown kernel options in the config
650 # - verbose printing of ComplexOptCheck items
651 # * json mode for printing the results in JSON format
652 report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
653 supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
654 parser = ArgumentParser(prog='kconfig-hardened-check',
655 description='Checks the hardening options in the Linux kernel config')
656 parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
657 parser.add_argument('-p', '--print', choices=supported_archs,
658 help='print hardening preferences for selected architecture')
659 parser.add_argument('-c', '--config',
660 help='check the kernel config file against these preferences')
661 parser.add_argument('-m', '--mode', choices=report_modes,
662 help='choose the report mode')
663 args = parser.parse_args()
669 print("[+] Special report mode: {}".format(mode))
671 config_checklist = []
675 print('[+] Config file to check: {}'.format(args.config))
677 arch, msg = detect_arch(args.config, supported_archs)
679 sys.exit('[!] ERROR: {}'.format(msg))
681 print('[+] Detected architecture: {}'.format(arch))
683 kernel_version, msg = detect_version(args.config)
684 if not kernel_version:
685 sys.exit('[!] ERROR: {}'.format(msg))
687 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
689 construct_checklist(config_checklist, arch)
690 parsed_options = OrderedDict()
691 parse_config_file(parsed_options, args.config)
692 perform_checks(config_checklist, parsed_options, kernel_version)
694 if mode == 'verbose':
695 print_unknown_options(config_checklist, parsed_options)
696 print_checklist(mode, config_checklist, True)
701 if mode in ('show_ok', 'show_fail'):
702 sys.exit('[!] ERROR: please use "{}" mode for checking the kernel config'.format(mode))
704 construct_checklist(config_checklist, arch)
706 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
707 print_checklist(mode, config_checklist, False)
713 if __name__ == '__main__':