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 # iommu=force (does it help against DMA attacks?)
16 # Mitigations of CPU vulnerabilities:
18 # mitigations=auto,nosmt (nosmt is slow)
20 # spec_store_bypass_disable=on
22 # l1d_flush=on (a part of the l1tf option)
30 # sysrq_always_enabled
35 # Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
37 # kasan.stacktrace=off
40 # N.B. Hardening sysctls:
41 # kernel.kptr_restrict=2 (or 1?)
42 # kernel.dmesg_restrict=1 (also see the kconfig option)
43 # kernel.perf_event_paranoid=3
44 # kernel.kexec_load_disabled=1
45 # kernel.yama.ptrace_scope=3
46 # user.max_user_namespaces=0
47 # what about bpf_jit_enable?
48 # kernel.unprivileged_bpf_disabled=1
49 # net.core.bpf_jit_harden=2
50 # vm.unprivileged_userfaultfd=0
51 # (at first, it disabled unprivileged userfaultfd,
52 # and since v5.11 it enables unprivileged userfaultfd for user-mode only)
53 # vm.mmap_min_addr has a good value
54 # dev.tty.ldisc_autoload=0
55 # fs.protected_symlinks=1
56 # fs.protected_hardlinks=1
57 # fs.protected_fifos=2
58 # fs.protected_regular=2
60 # kernel.modules_disabled=1
61 # kernel.randomize_va_space = 2
64 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
65 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
69 from argparse import ArgumentParser
70 from collections import OrderedDict
73 from .__about__ import __version__
75 SIMPLE_OPTION_TYPES = ('kconfig', 'version', 'cmdline')
78 # Constructor without the 'expected' parameter is for option presence checks (any value is OK)
79 def __init__(self, reason, decision, name, expected=None):
80 assert(reason and decision and name), \
81 'invalid {} check for "{}"'.format(self.__class__.__name__, name)
83 self.expected = expected
84 self.decision = decision
94 # handle the option presence check
95 if self.expected is None:
96 if self.state is None:
97 self.result = 'FAIL: not present'
99 self.result = 'OK: is present'
102 # handle the option value check
103 if self.expected == self.state:
105 elif self.state is None:
106 if self.expected == 'is not set':
107 self.result = 'OK: not found'
109 self.result = 'FAIL: not found'
111 self.result = 'FAIL: "' + self.state + '"'
113 def table_print(self, _mode, with_results):
114 if self.expected is None:
117 expected = self.expected
118 print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, expected, self.decision, self.reason), end='')
120 print('| {}'.format(self.result), end='')
122 def json_dump(self, with_results):
123 dump = [self.name, self.type, self.expected, self.decision, self.reason]
125 dump.append(self.result)
129 class KconfigCheck(OptCheck):
130 def __init__(self, *args, **kwargs):
131 super().__init__(*args, **kwargs)
132 self.name = 'CONFIG_' + self.name
139 class CmdlineCheck(OptCheck):
146 def __init__(self, ver_expected):
147 self.ver_expected = ver_expected
156 if self.ver[0] > self.ver_expected[0]:
157 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
159 if self.ver[0] < self.ver_expected[0]:
160 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
162 if self.ver[1] >= self.ver_expected[1]:
163 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
165 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
167 def table_print(self, _mode, with_results):
168 ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
169 print('{:<91}'.format(ver_req), end='')
171 print('| {}'.format(self.result), end='')
174 class ComplexOptCheck:
175 def __init__(self, *opts):
178 'empty {} check'.format(self.__class__.__name__)
179 assert(len(self.opts) != 1), \
180 'useless {} check: {}'.format(self.__class__.__name__, opts)
181 assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck))), \
182 'invalid {} check: {}'.format(self.__class__.__name__, opts)
191 return self.opts[0].name
195 return self.opts[0].expected
197 def table_print(self, mode, with_results):
198 if mode == 'verbose':
199 print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
201 print('| {}'.format(self.result), end='')
204 o.table_print(mode, with_results)
207 o.table_print(mode, False)
209 print('| {}'.format(self.result), end='')
211 def json_dump(self, with_results):
212 dump = self.opts[0].json_dump(False)
214 dump.append(self.result)
218 class OR(ComplexOptCheck):
219 # self.opts[0] is the option that this OR-check is about.
221 # OR(<X_is_hardened>, <X_is_disabled>)
222 # OR(<X_is_hardened>, <old_X_is_hardened>)
224 for i, opt in enumerate(self.opts):
226 if opt.result.startswith('OK'):
227 self.result = opt.result
228 # Add more info for additional checks:
230 if opt.result == 'OK':
231 self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
232 elif opt.result == 'OK: not found':
233 self.result = 'OK: {} not found'.format(opt.name)
234 elif opt.result == 'OK: is present':
235 self.result = 'OK: {} is present'.format(opt.name)
237 # VersionCheck provides enough info
238 assert(opt.result.startswith('OK: version')), \
239 'unexpected OK description "{}"'.format(opt.result)
241 self.result = self.opts[0].result
244 class AND(ComplexOptCheck):
245 # self.opts[0] is the option that this AND-check is about.
247 # AND(<suboption>, <main_option>)
248 # Suboption is not checked if checking of the main_option is failed.
249 # AND(<X_is_disabled>, <old_X_is_disabled>)
251 for i, opt in reversed(list(enumerate(self.opts))):
254 self.result = opt.result
256 if not opt.result.startswith('OK'):
257 # This FAIL is caused by additional checks,
258 # and not by the main option that this AND-check is about.
259 # Describe the reason of the FAIL.
260 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
261 self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
262 elif opt.result == 'FAIL: not present':
263 self.result = 'FAIL: {} not present'.format(opt.name)
265 # VersionCheck provides enough info
266 self.result = opt.result
267 assert(opt.result.startswith('FAIL: version')), \
268 'unexpected FAIL description "{}"'.format(opt.result)
272 def detect_arch(fname, archs):
273 with open(fname, 'r') as f:
274 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
276 for line in f.readlines():
277 if arch_pattern.match(line):
278 option, _ = line[7:].split('=', 1)
283 return None, 'more than one supported architecture is detected'
285 return None, 'failed to detect architecture'
289 def detect_kernel_version(fname):
290 with open(fname, 'r') as f:
291 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
292 for line in f.readlines():
293 if ver_pattern.match(line):
297 ver_numbers = ver_str.split('.')
298 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
299 msg = 'failed to parse the version "' + ver_str + '"'
301 return (int(ver_numbers[0]), int(ver_numbers[1])), None
302 return None, 'no kernel version detected'
305 def detect_compiler(fname):
308 with open(fname, 'r') as f:
309 gcc_version_pattern = re.compile("CONFIG_GCC_VERSION=[0-9]*")
310 clang_version_pattern = re.compile("CONFIG_CLANG_VERSION=[0-9]*")
311 for line in f.readlines():
312 if gcc_version_pattern.match(line):
313 gcc_version = line[19:-1]
314 if clang_version_pattern.match(line):
315 clang_version = line[21:-1]
316 if not gcc_version or not clang_version:
317 return None, 'no CONFIG_GCC_VERSION or CONFIG_CLANG_VERSION'
318 if gcc_version == '0' and clang_version != '0':
319 return 'CLANG ' + clang_version, 'OK'
320 if gcc_version != '0' and clang_version == '0':
321 return 'GCC ' + gcc_version, 'OK'
322 sys.exit('[!] ERROR: invalid GCC_VERSION and CLANG_VERSION: {} {}'.format(gcc_version, clang_version))
325 def add_kconfig_checks(l, arch):
326 # Calling the KconfigCheck class constructor:
327 # KconfigCheck(reason, decision, name, expected)
329 # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
330 # when the tool doesn't check the cmdline.
332 efi_not_set = KconfigCheck('-', '-', 'EFI', 'is not set')
333 cc_is_gcc = KconfigCheck('-', '-', 'CC_IS_GCC', 'y') # exists since v4.18
334 cc_is_clang = KconfigCheck('-', '-', 'CC_IS_CLANG', 'y') # exists since v4.18
336 modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
337 devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
338 bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
340 # 'self_protection', 'defconfig'
341 l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
342 l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
343 gcc_plugins_support_is_set = KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')
344 l += [gcc_plugins_support_is_set]
345 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
346 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'),
347 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_REGULAR', 'y'),
348 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_AUTO', 'y'),
349 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
350 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
351 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
352 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
353 KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
354 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
355 KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
356 modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
357 l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
358 VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
359 l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
360 iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
361 l += [iommu_support_is_set] # is needed for mitigating DMA attacks
362 if arch in ('X86_64', 'ARM64', 'X86_32'):
363 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
364 if arch in ('X86_64', 'ARM64'):
365 l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
366 if arch in ('X86_64', 'X86_32'):
367 l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE', 'y')]
368 l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_INTEL', 'y')]
369 l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_AMD', 'y')]
370 l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
371 l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
372 l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y'),
373 VersionCheck((5, 19)))] # X86_SMAP is enabled by default since v5.19
374 l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
375 l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
376 KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
377 if arch in ('ARM64', 'ARM'):
378 l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
380 l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
381 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
382 l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
383 iommu_support_is_set)]
384 l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
385 iommu_support_is_set)]
387 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
388 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
389 l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
390 l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
391 AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
392 VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
393 l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
394 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
395 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
396 l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
397 VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
398 l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
399 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
400 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
402 l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
403 l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
404 l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
406 # 'self_protection', 'kspp'
407 l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
408 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
409 l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
410 l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
411 l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
412 l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
413 l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
414 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
415 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
416 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
417 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
418 l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
419 l += [AND(KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y'),
420 gcc_plugins_support_is_set)]
421 l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
422 l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
423 l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
424 l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
425 l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
426 l += [KconfigCheck('self_protection', 'kspp', 'HW_RANDOM_TPM', 'y')]
427 randstruct_is_set = OR(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_FULL', 'y'),
428 KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y'))
429 l += [randstruct_is_set]
430 hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
431 l += [hardened_usercopy_is_set]
432 l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
433 hardened_usercopy_is_set)]
434 l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
435 hardened_usercopy_is_set)]
436 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
438 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
440 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
442 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
443 modules_not_set)] # refers to LOCKDOWN
444 l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
445 KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
446 l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
447 KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
448 # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
449 # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
450 # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
451 # the 0xAA poison pattern on allocation.
452 # That brings higher performance penalty.
453 ubsan_bounds_is_set = KconfigCheck('self_protection', 'kspp', 'UBSAN_BOUNDS', 'y')
454 l += [ubsan_bounds_is_set]
455 l += [OR(KconfigCheck('self_protection', 'kspp', 'UBSAN_LOCAL_BOUNDS', 'y'),
456 AND(ubsan_bounds_is_set,
458 l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_TRAP', 'y'),
460 KconfigCheck('self_protection', 'kspp', 'UBSAN_SHIFT', 'is not set'),
461 KconfigCheck('self_protection', 'kspp', 'UBSAN_DIV_ZERO', 'is not set'),
462 KconfigCheck('self_protection', 'kspp', 'UBSAN_UNREACHABLE', 'is not set'),
463 KconfigCheck('self_protection', 'kspp', 'UBSAN_BOOL', 'is not set'),
464 KconfigCheck('self_protection', 'kspp', 'UBSAN_ENUM', 'is not set'),
465 KconfigCheck('self_protection', 'kspp', 'UBSAN_ALIGNMENT', 'is not set'))] # only array index bounds checking with traps
466 if arch in ('X86_64', 'ARM64', 'X86_32'):
467 l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_SANITIZE_ALL', 'y'),
468 ubsan_bounds_is_set)] # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
469 stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
470 l += [AND(stackleak_is_set, gcc_plugins_support_is_set)]
471 l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
472 if arch in ('X86_64', 'X86_32'):
473 l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
474 l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
475 if arch in ('ARM64', 'ARM'):
476 l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
477 l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
479 l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
481 l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
482 l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
483 l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
485 # 'self_protection', 'clipos'
486 l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
487 l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
488 l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
490 l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
491 l += [AND(KconfigCheck('self_protection', 'clipos', 'RANDSTRUCT_PERFORMANCE', 'is not set'),
492 KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
494 if arch in ('X86_64', 'ARM64', 'X86_32'):
495 l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
497 gcc_plugins_support_is_set)]
498 l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
500 gcc_plugins_support_is_set)]
501 if arch in ('X86_64', 'X86_32'):
502 l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
503 iommu_support_is_set)]
505 l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
506 iommu_support_is_set)]
508 l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
509 iommu_support_is_set)]
511 # 'self_protection', 'my'
512 l += [OR(KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y'),
513 efi_not_set)] # needs userspace support (systemd)
515 l += [KconfigCheck('self_protection', 'my', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
516 l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
517 iommu_support_is_set)]
519 l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # maybe it's alternative to STACKPROTECTOR_STRONG
520 l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
521 cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
522 l += [cfi_clang_is_set]
523 l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
527 if arch in ('X86_64', 'ARM64', 'X86_32'):
528 l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
530 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
531 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
532 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LANDLOCK', 'y')]
533 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
534 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_BOOTPARAM', 'is not set')]
535 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DEVELOP', 'is not set')]
536 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM', 'y')]
537 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
538 l += [KconfigCheck('security_policy', 'kspp', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
539 l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
541 # 'cut_attack_surface', 'defconfig'
542 l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
543 bpf_syscall_not_set)] # see unprivileged_bpf_disabled
544 l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
545 l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
546 if arch in ('X86_64', 'ARM64', 'X86_32'):
547 l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
548 devmem_not_set)] # refers to LOCKDOWN
550 # 'cut_attack_surface', 'kspp'
551 l += [KconfigCheck('cut_attack_surface', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
552 l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
553 l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
554 l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
555 l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
556 l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
557 l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
558 l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
559 l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
560 l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
561 l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
562 l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
563 l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
564 l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
565 l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
566 l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
567 l += [modules_not_set]
568 l += [devmem_not_set]
569 l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
570 devmem_not_set)] # refers to LOCKDOWN
572 l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
573 devmem_not_set)] # refers to LOCKDOWN
575 l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
577 # 'cut_attack_surface', 'grsec'
578 l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
579 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
580 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
581 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
582 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
583 l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
584 l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
585 l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
586 l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
587 l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
588 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
589 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
590 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
591 l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
592 l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
593 l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
594 l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
595 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
596 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
597 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
598 l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
599 l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
600 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
601 l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
602 l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
603 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
604 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
605 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
606 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
607 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
608 l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
609 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
610 l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
611 l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
612 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
613 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
614 l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
615 l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
616 KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
618 # 'cut_attack_surface', 'maintainer'
619 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
620 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
621 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
622 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
623 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
625 # 'cut_attack_surface', 'grapheneos'
626 l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
628 # 'cut_attack_surface', 'clipos'
629 l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
630 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
631 # l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
632 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
633 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
634 l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
635 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
636 l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
637 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
638 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
639 l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
640 l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
641 l += [KconfigCheck('cut_attack_surface', 'clipos', 'COREDUMP', 'is not set')] # cut userspace attack surface
642 l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
643 KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
644 if arch in ('X86_64', 'X86_32'):
645 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
647 # 'cut_attack_surface', 'lockdown'
648 l += [bpf_syscall_not_set] # refers to LOCKDOWN
649 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
650 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
651 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
653 # 'cut_attack_surface', 'my'
654 l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
656 l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
657 l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
658 l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
659 l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
660 l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
661 l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
662 l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
663 l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
666 if arch in ('X86_64', 'ARM64', 'X86_32'):
667 l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
669 l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
671 l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
672 l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_BTI', 'y')]
673 if arch in ('ARM', 'X86_32'):
674 l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
675 if arch in ('X86_64', 'ARM64'):
676 l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
677 if arch in ('X86_32', 'ARM'):
678 l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
681 def add_cmdline_checks(l, arch):
682 # Calling the CmdlineCheck class constructor:
683 # CmdlineCheck(reason, decision, name, expected)
685 # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
686 # when the tool doesn't check the cmdline.
688 # [!] Make sure that values of the options in CmdlineChecks need normalization.
689 # For more info see normalize_cmdline_options().
691 # A common pattern for checking the 'param_x' cmdline parameter
692 # that __overrides__ the 'PARAM_X_DEFAULT' kconfig option:
693 # l += [OR(CmdlineCheck(reason, decision, 'param_x', '1'),
694 # AND(KconfigCheck(reason, decision, 'PARAM_X_DEFAULT_ON', 'y'),
695 # CmdlineCheck(reason, decision, 'param_x, 'is not set')))]
697 # Here we don't check the kconfig options or minimal kernel version
698 # required for the cmdline parameters. That would make the checks
699 # very complex and not give a 100% guarantee anyway.
701 # 'self_protection', 'defconfig'
702 l += [CmdlineCheck('self_protection', 'defconfig', 'nosmep', 'is not set')]
703 l += [CmdlineCheck('self_protection', 'defconfig', 'nosmap', 'is not set')]
704 l += [CmdlineCheck('self_protection', 'defconfig', 'nokaslr', 'is not set')]
705 l += [CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set')]
706 l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v1', 'is not set')]
707 l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v2', 'is not set')]
709 l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
710 AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
711 CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]
713 l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', '1'),
714 CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set'))]
716 # 'self_protection', 'kspp'
717 l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
718 AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
719 CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
720 l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
721 AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
722 CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
723 AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
724 KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
725 CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
726 l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'),
727 AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
728 CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')))] # option presence check
729 l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
730 AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
731 CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
732 l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', '0'),
733 AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set'),
734 CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', 'is not set')))]
735 # The cmdline checks compatible with the kconfig recommendations of the KSPP project...
736 l += [OR(CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', '1'),
737 AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y'),
738 CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', 'is not set')))]
739 l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', '0'),
740 AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
741 CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', 'is not set')))]
743 if arch in ('X86_64', 'ARM64', 'X86_32'):
744 l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
745 AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
746 CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
747 if arch in ('X86_64', 'X86_32'):
748 l += [AND(CmdlineCheck('self_protection', 'kspp', 'pti', 'on'),
749 CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set'))]
751 # 'self_protection', 'clipos'
752 l += [CmdlineCheck('self_protection', 'clipos', 'page_alloc.shuffle', '1')]
753 if arch in ('X86_64', 'X86_32'):
754 l += [AND(CmdlineCheck('self_protection', 'clipos', 'spectre_v2', 'on'),
755 CmdlineCheck('self_protection', 'defconfig', 'nospectre_v2', 'is not set'))]
757 # 'cut_attack_surface', 'kspp'
759 l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
760 AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
761 CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
763 # 'cut_attack_surface', 'grsec'
764 # The cmdline checks compatible with the kconfig options disabled by grsecurity...
765 l += [OR(CmdlineCheck('cut_attack_surface', 'grsec', 'debugfs', 'off'),
766 KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set'))] # ... the end
769 def print_unknown_options(checklist, parsed_options):
773 if o1.type != 'complex':
774 known_options.append(o1.name)
777 if o2.type != 'complex':
778 if hasattr(o2, 'name'):
779 known_options.append(o2.name)
782 assert(o3.type != 'complex'), \
783 'unexpected ComplexOptCheck inside {}'.format(o2.name)
784 if hasattr(o3, 'name'):
785 known_options.append(o3.name)
787 for option, value in parsed_options.items():
788 if option not in known_options:
789 print('[?] No check for option {} ({})'.format(option, value))
792 def print_checklist(mode, checklist, with_results):
796 output.append(o.json_dump(with_results))
797 print(json.dumps(output))
804 print('=' * sep_line_len)
805 print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
807 print('| {}'.format('check result'), end='')
809 print('=' * sep_line_len)
812 for opt in checklist:
814 if mode == 'show_ok':
815 if not opt.result.startswith('OK'):
817 if mode == 'show_fail':
818 if not opt.result.startswith('FAIL'):
820 opt.table_print(mode, with_results)
822 if mode == 'verbose':
823 print('-' * sep_line_len)
828 fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
830 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
832 if mode == 'show_ok':
833 fail_suppressed = ' (suppressed in output)'
834 if mode == 'show_fail':
835 ok_suppressed = ' (suppressed in output)'
837 print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
840 def populate_simple_opt_with_data(opt, data, data_type):
841 assert(opt.type != 'complex'), \
842 'unexpected ComplexOptCheck "{}"'.format(opt.name)
843 assert(opt.type in SIMPLE_OPTION_TYPES), \
844 'invalid opt type "{}"'.format(opt.type)
845 assert(data_type in SIMPLE_OPTION_TYPES), \
846 'invalid data type "{}"'.format(data_type)
848 if data_type != opt.type:
851 if data_type in ('kconfig', 'cmdline'):
852 opt.state = data.get(opt.name, None)
854 assert(data_type == 'version'), \
855 'unexpected data type "{}"'.format(data_type)
859 def populate_opt_with_data(opt, data, data_type):
860 if opt.type == 'complex':
862 if o.type == 'complex':
863 # Recursion for nested ComplexOptCheck objects
864 populate_opt_with_data(o, data, data_type)
866 populate_simple_opt_with_data(o, data, data_type)
868 assert(opt.type in ('kconfig', 'cmdline')), \
869 'bad type "{}" for a simple check'.format(opt.type)
870 populate_simple_opt_with_data(opt, data, data_type)
873 def populate_with_data(checklist, data, data_type):
874 for opt in checklist:
875 populate_opt_with_data(opt, data, data_type)
878 def perform_checks(checklist):
879 for opt in checklist:
883 def parse_kconfig_file(parsed_options, fname):
884 with open(fname, 'r') as f:
885 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
886 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
888 for line in f.readlines():
893 if opt_is_on.match(line):
894 option, value = line.split('=', 1)
895 if value == 'is not set':
896 sys.exit('[!] ERROR: bad enabled kconfig option "{}"'.format(line))
897 elif opt_is_off.match(line):
898 option, value = line[2:].split(' ', 1)
899 if value != 'is not set':
900 sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
902 if option in parsed_options:
903 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
906 parsed_options[option] = value
909 def normalize_cmdline_options(option, value):
910 # Don't normalize the cmdline option values if
911 # the Linux kernel doesn't use kstrtobool() for them
913 # See pti_check_boottime_disable() in linux/arch/x86/mm/pti.c
915 if option == 'spectre_v2':
916 # See spectre_v2_parse_cmdline() in linux/arch/x86/kernel/cpu/bugs.c
918 if option == 'debugfs':
919 # See debugfs_kernel() in fs/debugfs/inode.c
922 # Implement a limited part of the kstrtobool() logic
923 if value in ('1', 'on', 'On', 'ON', 'y', 'Y', 'yes', 'Yes', 'YES'):
925 if value in ('0', 'off', 'Off', 'OFF', 'n', 'N', 'no', 'No', 'NO'):
928 # Preserve unique values
932 def parse_cmdline_file(parsed_options, fname):
933 with open(fname, 'r') as f:
939 sys.exit('[!] ERROR: more than one line in "{}"'.format(fname))
943 name, value = opt.split('=', 1)
946 value = '' # '' is not None
947 value = normalize_cmdline_options(name, value)
948 parsed_options[name] = value
954 # - reporting about unknown kernel options in the kconfig
955 # - verbose printing of ComplexOptCheck items
956 # * json mode for printing the results in JSON format
957 report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
958 supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
959 parser = ArgumentParser(prog='kconfig-hardened-check',
960 description='A tool for checking the security hardening options of the Linux kernel')
961 parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
962 parser.add_argument('-p', '--print', choices=supported_archs,
963 help='print security hardening preferences for the selected architecture')
964 parser.add_argument('-c', '--config',
965 help='check the kernel kconfig file against these preferences')
966 parser.add_argument('-l', '--cmdline',
967 help='check the kernel cmdline file against these preferences')
968 parser.add_argument('-m', '--mode', choices=report_modes,
969 help='choose the report mode')
970 args = parser.parse_args()
976 print('[+] Special report mode: {}'.format(mode))
978 config_checklist = []
982 sys.exit('[!] ERROR: --config and --print can\'t be used together')
985 print('[+] Kconfig file to check: {}'.format(args.config))
987 print('[+] Kernel cmdline file to check: {}'.format(args.cmdline))
989 arch, msg = detect_arch(args.config, supported_archs)
991 sys.exit('[!] ERROR: {}'.format(msg))
993 print('[+] Detected architecture: {}'.format(arch))
995 kernel_version, msg = detect_kernel_version(args.config)
996 if not kernel_version:
997 sys.exit('[!] ERROR: {}'.format(msg))
999 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
1001 compiler, msg = detect_compiler(args.config)
1004 print('[+] Detected compiler: {}'.format(compiler))
1006 print('[-] Can\'t detect the compiler: {}'.format(msg))
1008 # add relevant kconfig checks to the checklist
1009 add_kconfig_checks(config_checklist, arch)
1012 # add relevant cmdline checks to the checklist
1013 add_cmdline_checks(config_checklist, arch)
1015 # populate the checklist with the parsed kconfig data
1016 parsed_kconfig_options = OrderedDict()
1017 parse_kconfig_file(parsed_kconfig_options, args.config)
1018 populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
1019 populate_with_data(config_checklist, kernel_version, 'version')
1022 # populate the checklist with the parsed kconfig data
1023 parsed_cmdline_options = OrderedDict()
1024 parse_cmdline_file(parsed_cmdline_options, args.cmdline)
1025 populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
1027 # now everything is ready for performing the checks
1028 perform_checks(config_checklist)
1030 # finally print the results
1031 if mode == 'verbose':
1032 print_unknown_options(config_checklist, parsed_kconfig_options)
1033 print_checklist(mode, config_checklist, True)
1037 sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking kconfig')
1040 if mode in ('show_ok', 'show_fail'):
1041 sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
1043 add_kconfig_checks(config_checklist, arch)
1044 add_cmdline_checks(config_checklist, arch)
1046 print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
1047 print_checklist(mode, config_checklist, False)