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 # Please don't cry if my Python code looks like C.
13 # N.B Hardening command line parameters:
14 # page_alloc.shuffle=1
15 # iommu=force (does it help against DMA attacks?)
16 # slub_debug=FZ (slow)
18 # debugfs=no-mount (or off if possible)
20 # Mitigations of CPU vulnerabilities:
22 # mitigations=auto,nosmt (nosmt is slow)
25 # spec_store_bypass_disable=on
27 # l1d_flush=on (a part of the l1tf option)
36 # sysrq_always_enabled
41 # Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
43 # kasan.stacktrace=off
46 # N.B. Hardening sysctls:
47 # kernel.kptr_restrict=2 (or 1?)
48 # kernel.dmesg_restrict=1 (also see the kconfig option)
49 # kernel.perf_event_paranoid=3
50 # kernel.kexec_load_disabled=1
51 # kernel.yama.ptrace_scope=3
52 # user.max_user_namespaces=0
53 # what about bpf_jit_enable?
54 # kernel.unprivileged_bpf_disabled=1
55 # net.core.bpf_jit_harden=2
56 # vm.unprivileged_userfaultfd=0
57 # (at first, it disabled unprivileged userfaultfd,
58 # and since v5.11 it enables unprivileged userfaultfd for user-mode only)
59 # vm.mmap_min_addr has a good value
60 # dev.tty.ldisc_autoload=0
61 # fs.protected_symlinks=1
62 # fs.protected_hardlinks=1
63 # fs.protected_fifos=2
64 # fs.protected_regular=2
66 # kernel.modules_disabled=1
67 # kernel.randomize_va_space = 2
70 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
71 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
75 from argparse import ArgumentParser
76 from collections import OrderedDict
79 from .__about__ import __version__
81 SIMPLE_OPTION_TYPES = ('kconfig', 'version', 'cmdline')
84 # Constructor without the 'expected' parameter is for option presence checks (any value is OK)
85 def __init__(self, reason, decision, name, expected=None):
86 assert(reason and decision and name), \
87 'invalid {} check for "{}"'.format(self.__class__.__name__, name)
89 self.expected = expected
90 self.decision = decision
100 # handle the option presence check
101 if self.expected is None:
102 if self.state is None:
103 self.result = 'FAIL: not present'
105 self.result = 'OK: is present'
108 # handle the option value check
109 if self.expected == self.state:
111 elif self.state is None:
112 if self.expected == 'is not set':
113 self.result = 'OK: not found'
115 self.result = 'FAIL: not found'
117 self.result = 'FAIL: "' + self.state + '"'
119 def table_print(self, _mode, with_results):
120 if self.expected is None:
123 expected = self.expected
124 print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, expected, self.decision, self.reason), end='')
126 print('| {}'.format(self.result), end='')
128 def json_dump(self, with_results):
129 dump = [self.name, self.type, self.expected, self.decision, self.reason]
131 dump.append(self.result)
135 class KconfigCheck(OptCheck):
136 def __init__(self, *args, **kwargs):
137 super().__init__(*args, **kwargs)
138 self.name = 'CONFIG_' + self.name
145 class CmdlineCheck(OptCheck):
152 def __init__(self, ver_expected):
153 self.ver_expected = ver_expected
162 if self.ver[0] > self.ver_expected[0]:
163 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
165 if self.ver[0] < self.ver_expected[0]:
166 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
168 if self.ver[1] >= self.ver_expected[1]:
169 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
171 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
173 def table_print(self, _mode, with_results):
174 ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
175 print('{:<91}'.format(ver_req), end='')
177 print('| {}'.format(self.result), end='')
180 class ComplexOptCheck:
181 def __init__(self, *opts):
184 'empty {} check'.format(self.__class__.__name__)
185 assert(len(self.opts) != 1), \
186 'useless {} check: {}'.format(self.__class__.__name__, opts)
187 assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck))), \
188 'invalid {} check: {}'.format(self.__class__.__name__, opts)
197 return self.opts[0].name
201 return self.opts[0].expected
203 def table_print(self, mode, with_results):
204 if mode == 'verbose':
205 print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
207 print('| {}'.format(self.result), end='')
210 o.table_print(mode, with_results)
213 o.table_print(mode, False)
215 print('| {}'.format(self.result), end='')
217 def json_dump(self, with_results):
218 dump = self.opts[0].json_dump(False)
220 dump.append(self.result)
224 class OR(ComplexOptCheck):
225 # self.opts[0] is the option that this OR-check is about.
227 # OR(<X_is_hardened>, <X_is_disabled>)
228 # OR(<X_is_hardened>, <old_X_is_hardened>)
230 for i, opt in enumerate(self.opts):
232 if opt.result.startswith('OK'):
233 self.result = opt.result
234 # Add more info for additional checks:
236 if opt.result == 'OK':
237 self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
238 elif opt.result == 'OK: not found':
239 self.result = 'OK: {} not found'.format(opt.name)
240 elif opt.result == 'OK: is present':
241 self.result = 'OK: {} is present'.format(opt.name)
243 # VersionCheck provides enough info
244 assert(opt.result.startswith('OK: version')), \
245 'unexpected OK description "{}"'.format(opt.result)
247 self.result = self.opts[0].result
250 class AND(ComplexOptCheck):
251 # self.opts[0] is the option that this AND-check is about.
253 # AND(<suboption>, <main_option>)
254 # Suboption is not checked if checking of the main_option is failed.
255 # AND(<X_is_disabled>, <old_X_is_disabled>)
257 for i, opt in reversed(list(enumerate(self.opts))):
260 self.result = opt.result
262 if not opt.result.startswith('OK'):
263 # This FAIL is caused by additional checks,
264 # and not by the main option that this AND-check is about.
265 # Describe the reason of the FAIL.
266 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
267 self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
268 elif opt.result == 'FAIL: not present':
269 self.result = 'FAIL: {} not present'.format(opt.name)
271 # VersionCheck provides enough info
272 self.result = opt.result
273 assert(opt.result.startswith('FAIL: version')), \
274 'unexpected FAIL description "{}"'.format(opt.result)
278 def detect_arch(fname, archs):
279 with open(fname, 'r') as f:
280 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
282 for line in f.readlines():
283 if arch_pattern.match(line):
284 option, _ = line[7:].split('=', 1)
289 return None, 'more than one supported architecture is detected'
291 return None, 'failed to detect architecture'
295 def detect_version(fname):
296 with open(fname, 'r') as f:
297 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
298 for line in f.readlines():
299 if ver_pattern.match(line):
303 ver_numbers = ver_str.split('.')
304 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
305 msg = 'failed to parse the version "' + ver_str + '"'
307 return (int(ver_numbers[0]), int(ver_numbers[1])), None
308 return None, 'no kernel version detected'
311 def add_kconfig_checks(l, arch):
312 # Calling the KconfigCheck class constructor:
313 # KconfigCheck(reason, decision, name, expected)
315 # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
316 # when the tool doesn't check the cmdline.
318 modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
319 devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
320 bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
321 efi_not_set = KconfigCheck('cut_attack_surface', 'my', 'EFI', 'is not set')
323 # 'self_protection', 'defconfig'
324 l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
325 l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
326 l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
327 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
328 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'),
329 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_REGULAR', 'y'),
330 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_AUTO', 'y'),
331 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
332 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
333 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
334 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
335 KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
336 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
337 KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
338 modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
339 l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
340 VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
341 l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
342 iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
343 l += [iommu_support_is_set] # is needed for mitigating DMA attacks
344 if arch in ('X86_64', 'ARM64', 'X86_32'):
345 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
346 if arch in ('X86_64', 'ARM64'):
347 l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
348 if arch in ('X86_64', 'X86_32'):
349 l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
350 l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
351 l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
352 l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
353 l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
354 KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
355 if arch in ('ARM64', 'ARM'):
356 l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
358 l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
359 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
360 l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
361 iommu_support_is_set)]
362 l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
363 iommu_support_is_set)]
365 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
366 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
367 l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
368 l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
369 AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
370 VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
371 l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
372 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
373 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
374 l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
375 VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
376 l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
377 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
378 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
380 l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
381 l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
382 l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
384 # 'self_protection', 'kspp'
385 l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
386 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
387 l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
388 l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
389 l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
390 l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
391 l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
392 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
393 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
394 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
395 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
396 l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
397 l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
398 l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
399 l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
400 l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
401 l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
402 l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
403 randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
404 l += [randstruct_is_set]
405 hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
406 l += [hardened_usercopy_is_set]
407 l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
408 hardened_usercopy_is_set)]
409 l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
410 hardened_usercopy_is_set)]
411 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
413 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
415 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
417 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
418 modules_not_set)] # refers to LOCKDOWN
419 l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
420 KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
421 l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
422 KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
423 # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
424 # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
425 # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
426 # the 0xAA poison pattern on allocation.
427 # That brings higher performance penalty.
428 if arch in ('X86_64', 'ARM64', 'X86_32'):
429 stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
430 l += [stackleak_is_set]
431 l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
432 if arch in ('X86_64', 'X86_32'):
433 l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
434 l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
435 if arch in ('ARM64', 'ARM'):
436 l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
437 l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
439 l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
441 l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
442 l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
443 l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
445 # 'self_protection', 'maintainer'
446 ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
447 l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
448 if arch in ('X86_64', 'ARM64', 'X86_32'): # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
449 l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
450 ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
451 l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
452 ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
454 # 'self_protection', 'clipos'
455 l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
456 l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
457 l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
459 l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
460 l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
461 l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
462 l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
464 if arch in ('X86_64', 'ARM64', 'X86_32'):
465 l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
467 l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
469 if arch in ('X86_64', 'X86_32'):
470 l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
471 iommu_support_is_set)]
473 l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
474 iommu_support_is_set)]
476 l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
477 iommu_support_is_set)]
479 # 'self_protection', 'my'
480 l += [OR(KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y'),
481 efi_not_set)] # needs userspace support (systemd)
483 l += [KconfigCheck('self_protection', 'my', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
484 l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
485 iommu_support_is_set)]
487 l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
488 l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
489 cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
490 l += [cfi_clang_is_set]
491 l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
495 if arch in ('X86_64', 'ARM64', 'X86_32'):
496 l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
498 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
499 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
500 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
501 l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
502 l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
503 l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
504 l += [KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
505 l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
506 loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
507 l += [loadpin_is_set] # needs userspace support
508 l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
511 # 'cut_attack_surface', 'defconfig'
512 l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
513 bpf_syscall_not_set)] # see unprivileged_bpf_disabled
514 l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
515 l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
516 if arch in ('X86_64', 'ARM64', 'X86_32'):
517 l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
518 devmem_not_set)] # refers to LOCKDOWN
520 # 'cut_attack_surface', 'kspp'
521 l += [KconfigCheck('cut_attack_surface', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
522 l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
523 l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
524 l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
525 l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
526 l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
527 l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
528 l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
529 l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
530 l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
531 l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
532 l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
533 l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
534 l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
535 l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
536 l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
537 l += [modules_not_set]
538 l += [devmem_not_set]
539 l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
540 devmem_not_set)] # refers to LOCKDOWN
542 l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
543 devmem_not_set)] # refers to LOCKDOWN
545 l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
547 # 'cut_attack_surface', 'grsec'
548 l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
549 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
550 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
551 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
552 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
553 l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
554 l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
555 l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
556 l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
557 l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
558 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
559 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
560 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
561 l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
562 l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
563 l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
564 l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
565 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
566 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
567 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
568 l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
569 l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
570 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
571 l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
572 l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
573 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
574 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
575 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
576 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
577 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
578 l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
579 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
580 l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
581 l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
582 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
583 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
584 l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
585 l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
586 KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
588 # 'cut_attack_surface', 'maintainer'
589 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
590 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
591 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
592 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
593 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
595 # 'cut_attack_surface', 'grapheneos'
596 l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
598 # 'cut_attack_surface', 'clipos'
599 l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
600 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
601 # l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
602 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
603 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
604 l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
605 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
606 l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
607 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
608 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
609 l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
610 l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
611 l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
612 KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
613 if arch in ('X86_64', 'X86_32'):
614 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
616 # 'cut_attack_surface', 'lockdown'
617 l += [bpf_syscall_not_set] # refers to LOCKDOWN
618 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
619 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
620 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
622 # 'cut_attack_surface', 'my'
623 l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
625 l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
626 l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
627 l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
628 l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
629 l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
630 l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
631 l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
632 l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
635 if arch in ('X86_64', 'ARM64', 'X86_32'):
636 l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
638 l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
640 l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
641 l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_BTI', 'y')]
642 if arch in ('ARM', 'X86_32'):
643 l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
644 if arch in ('X86_64', 'ARM64'):
645 l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
646 if arch in ('X86_32', 'ARM'):
647 l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
650 def add_cmdline_checks(l, arch):
651 # Calling the CmdlineCheck class constructor:
652 # CmdlineCheck(reason, decision, name, expected)
654 # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
655 # when the tool doesn't check the cmdline.
657 # A common pattern for checking the 'param_x' cmdline parameter
658 # that __overrides__ the 'PARAM_X_DEFAULT' kconfig option:
659 # l += [OR(CmdlineCheck(reason, decision, 'param_x', '1'),
660 # AND(KconfigCheck(reason, decision, 'PARAM_X_DEFAULT_ON', 'y'),
661 # CmdlineCheck(reason, decision, 'param_x, 'is not set')))]
663 # Here we don't check the kconfig options or minimal kernel version
664 # required for the cmdline parameters. That would make the checks
665 # very complex and not give a 100% guarantee anyway.
668 l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
669 AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
670 CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]
672 l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', '1'),
673 CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set'))]
675 l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
676 AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
677 CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
678 l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
679 AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
680 CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
681 AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
682 KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
683 CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
684 l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'),
685 AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
686 CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')))] # option presence check
687 l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
688 AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
689 CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
690 l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', '0'),
691 AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set'),
692 CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', 'is not set')))]
693 l += [OR(CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', '1'),
694 AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y'),
695 CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', 'is not set')))]
696 l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', '0'),
697 AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
698 CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', 'is not set')))]
699 if arch in ('X86_64', 'ARM64', 'X86_32'):
700 l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
701 AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
702 CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
703 if arch in ('X86_64', 'X86_32'):
704 l += [CmdlineCheck('self_protection', 'kspp', 'pti', 'on')]
707 l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
708 AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
709 CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
714 def print_unknown_options(checklist, parsed_options):
718 if o1.type != 'complex':
719 known_options.append(o1.name)
722 if o2.type != 'complex':
723 if hasattr(o2, 'name'):
724 known_options.append(o2.name)
727 assert(o3.type != 'complex'), \
728 'unexpected ComplexOptCheck inside {}'.format(o2.name)
729 if hasattr(o3, 'name'):
730 known_options.append(o3.name)
732 for option, value in parsed_options.items():
733 if option not in known_options:
734 print('[?] No check for option {} ({})'.format(option, value))
737 def print_checklist(mode, checklist, with_results):
741 output.append(o.json_dump(with_results))
742 print(json.dumps(output))
749 print('=' * sep_line_len)
750 print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
752 print('| {}'.format('check result'), end='')
754 print('=' * sep_line_len)
757 for opt in checklist:
759 if mode == 'show_ok':
760 if not opt.result.startswith('OK'):
762 if mode == 'show_fail':
763 if not opt.result.startswith('FAIL'):
765 opt.table_print(mode, with_results)
767 if mode == 'verbose':
768 print('-' * sep_line_len)
773 fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
775 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
777 if mode == 'show_ok':
778 fail_suppressed = ' (suppressed in output)'
779 if mode == 'show_fail':
780 ok_suppressed = ' (suppressed in output)'
782 print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
785 def populate_simple_opt_with_data(opt, data, data_type):
786 assert(opt.type != 'complex'), \
787 'unexpected ComplexOptCheck "{}"'.format(opt.name)
788 assert(opt.type in SIMPLE_OPTION_TYPES), \
789 'invalid opt type "{}"'.format(opt.type)
790 assert(data_type in SIMPLE_OPTION_TYPES), \
791 'invalid data type "{}"'.format(data_type)
793 if data_type != opt.type:
796 if data_type in ('kconfig', 'cmdline'):
797 opt.state = data.get(opt.name, None)
799 assert(data_type == 'version'), \
800 'unexpected data type "{}"'.format(data_type)
804 def populate_opt_with_data(opt, data, data_type):
805 if opt.type == 'complex':
807 if o.type == 'complex':
808 # Recursion for nested ComplexOptCheck objects
809 populate_opt_with_data(o, data, data_type)
811 populate_simple_opt_with_data(o, data, data_type)
813 assert(opt.type in ('kconfig', 'cmdline')), \
814 'bad type "{}" for a simple check'.format(opt.type)
815 populate_simple_opt_with_data(opt, data, data_type)
818 def populate_with_data(checklist, data, data_type):
819 for opt in checklist:
820 populate_opt_with_data(opt, data, data_type)
823 def perform_checks(checklist):
824 for opt in checklist:
828 def parse_kconfig_file(parsed_options, fname):
829 with open(fname, 'r') as f:
830 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
831 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
833 for line in f.readlines():
838 if opt_is_on.match(line):
839 option, value = line.split('=', 1)
840 if value == 'is not set':
841 sys.exit('[!] ERROR: bad enabled kconfig option "{}"'.format(line))
842 elif opt_is_off.match(line):
843 option, value = line[2:].split(' ', 1)
844 if value != 'is not set':
845 sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
847 if option in parsed_options:
848 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
851 parsed_options[option] = value
854 def parse_cmdline_file(parsed_options, fname):
855 with open(fname, 'r') as f:
861 sys.exit('[!] ERROR: more than one line in "{}"'.format(fname))
865 name, value = opt.split('=', 1)
868 value = '' # '' is not None
869 parsed_options[name] = value
875 # - reporting about unknown kernel options in the kconfig
876 # - verbose printing of ComplexOptCheck items
877 # * json mode for printing the results in JSON format
878 report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
879 supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
880 parser = ArgumentParser(prog='kconfig-hardened-check',
881 description='A tool for checking the security hardening options of the Linux kernel')
882 parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
883 parser.add_argument('-p', '--print', choices=supported_archs,
884 help='print security hardening preferences for the selected architecture')
885 parser.add_argument('-c', '--config',
886 help='check the kernel kconfig file against these preferences')
887 parser.add_argument('-l', '--cmdline',
888 help='check the kernel cmdline file against these preferences')
889 parser.add_argument('-m', '--mode', choices=report_modes,
890 help='choose the report mode')
891 args = parser.parse_args()
897 print('[+] Special report mode: {}'.format(mode))
899 config_checklist = []
903 sys.exit('[!] ERROR: --config and --print can\'t be used together')
906 print('[+] Kconfig file to check: {}'.format(args.config))
908 print('[+] Kernel cmdline file to check: {}'.format(args.cmdline))
910 arch, msg = detect_arch(args.config, supported_archs)
912 sys.exit('[!] ERROR: {}'.format(msg))
914 print('[+] Detected architecture: {}'.format(arch))
916 kernel_version, msg = detect_version(args.config)
917 if not kernel_version:
918 sys.exit('[!] ERROR: {}'.format(msg))
920 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
922 # add relevant kconfig checks to the checklist
923 add_kconfig_checks(config_checklist, arch)
926 # add relevant cmdline checks to the checklist
927 add_cmdline_checks(config_checklist, arch)
929 # populate the checklist with the parsed kconfig data
930 parsed_kconfig_options = OrderedDict()
931 parse_kconfig_file(parsed_kconfig_options, args.config)
932 populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
933 populate_with_data(config_checklist, kernel_version, 'version')
936 # populate the checklist with the parsed kconfig data
937 parsed_cmdline_options = OrderedDict()
938 parse_cmdline_file(parsed_cmdline_options, args.cmdline)
939 populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
941 # now everything is ready for performing the checks
942 perform_checks(config_checklist)
944 # finally print the results
945 if mode == 'verbose':
946 print_unknown_options(config_checklist, parsed_kconfig_options)
947 print_checklist(mode, config_checklist, True)
951 sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking kconfig')
954 if mode in ('show_ok', 'show_fail'):
955 sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
957 add_kconfig_checks(config_checklist, arch)
958 add_cmdline_checks(config_checklist, arch)
960 print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
961 print_checklist(mode, config_checklist, False)