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?)
18 # slub_debug=FZ (slow)
19 # init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
21 # debugfs=no-mount (or off if possible)
23 # Mitigations of CPU vulnerabilities:
25 # mitigations=auto,nosmt (nosmt is slow)
28 # spec_store_bypass_disable=on
30 # l1d_flush=on (a part of the l1tf option)
41 # sysrq_always_enabled
46 # Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
48 # kasan.stacktrace=off
51 # N.B. Hardening sysctls:
52 # kernel.kptr_restrict=2 (or 1?)
53 # kernel.dmesg_restrict=1 (also see the kconfig option)
54 # kernel.perf_event_paranoid=3
55 # kernel.kexec_load_disabled=1
56 # kernel.yama.ptrace_scope=3
57 # user.max_user_namespaces=0
58 # what about bpf_jit_enable?
59 # kernel.unprivileged_bpf_disabled=1
60 # net.core.bpf_jit_harden=2
61 # vm.unprivileged_userfaultfd=0
62 # (at first, it disabled unprivileged userfaultfd,
63 # and since v5.11 it enables unprivileged userfaultfd for user-mode only)
64 # dev.tty.ldisc_autoload=0
65 # fs.protected_symlinks=1
66 # fs.protected_hardlinks=1
67 # fs.protected_fifos=2
68 # fs.protected_regular=2
70 # kernel.modules_disabled=1
71 # kernel.randomize_va_space = 2
74 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
75 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
79 from argparse import ArgumentParser
80 from collections import OrderedDict
83 from .__about__ import __version__
85 SIMPLE_OPTION_TYPES = ('kconfig', 'version', 'cmdline')
88 # Constructor without the 'expected' parameter is for option presence checks (any value is OK)
89 def __init__(self, reason, decision, name, expected=None):
90 assert(reason and decision and name), \
91 'invalid {} check for "{}"'.format(self.__class__.__name__, name)
93 self.expected = expected
94 self.decision = decision
104 # handle the option presence check
105 if self.expected is None:
106 if self.state is None:
107 self.result = 'FAIL: not present'
109 self.result = 'OK: is present'
112 # handle the option value check
113 if self.expected == self.state:
115 elif self.state is None:
116 if self.expected == 'is not set':
117 self.result = 'OK: not found'
119 self.result = 'FAIL: not found'
121 self.result = 'FAIL: "' + self.state + '"'
123 def table_print(self, _mode, with_results):
124 if self.expected is None:
127 expected = self.expected
128 print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, expected, self.decision, self.reason), end='')
130 print('| {}'.format(self.result), end='')
132 def json_dump(self, with_results):
133 dump = [self.name, self.type, self.expected, self.decision, self.reason]
135 dump.append(self.result)
139 class KconfigCheck(OptCheck):
140 def __init__(self, *args, **kwargs):
141 super().__init__(*args, **kwargs)
142 self.name = 'CONFIG_' + self.name
149 class CmdlineCheck(OptCheck):
156 def __init__(self, ver_expected):
157 self.ver_expected = ver_expected
166 if self.ver[0] > self.ver_expected[0]:
167 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
169 if self.ver[0] < self.ver_expected[0]:
170 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
172 if self.ver[1] >= self.ver_expected[1]:
173 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
175 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
177 def table_print(self, _mode, with_results):
178 ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
179 print('{:<91}'.format(ver_req), end='')
181 print('| {}'.format(self.result), end='')
184 class ComplexOptCheck:
185 def __init__(self, *opts):
188 'empty {} check'.format(self.__class__.__name__)
189 assert(len(self.opts) != 1), \
190 'useless {} check: {}'.format(self.__class__.__name__, opts)
191 assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck))), \
192 'invalid {} check: {}'.format(self.__class__.__name__, opts)
201 return self.opts[0].name
205 return self.opts[0].expected
207 def table_print(self, mode, with_results):
208 if mode == 'verbose':
209 print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
211 print('| {}'.format(self.result), end='')
214 o.table_print(mode, with_results)
217 o.table_print(mode, False)
219 print('| {}'.format(self.result), end='')
221 def json_dump(self, with_results):
222 dump = self.opts[0].json_dump(False)
224 dump.append(self.result)
228 class OR(ComplexOptCheck):
229 # self.opts[0] is the option that this OR-check is about.
231 # OR(<X_is_hardened>, <X_is_disabled>)
232 # OR(<X_is_hardened>, <old_X_is_hardened>)
234 for i, opt in enumerate(self.opts):
236 if opt.result.startswith('OK'):
237 self.result = opt.result
238 # Add more info for additional checks:
240 if opt.result == 'OK':
241 self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
242 elif opt.result == 'OK: not found':
243 self.result = 'OK: {} not found'.format(opt.name)
244 elif opt.result == 'OK: is present':
245 self.result = 'OK: {} is present'.format(opt.name)
247 # VersionCheck provides enough info
248 assert(opt.result.startswith('OK: version')), \
249 'unexpected OK description "{}"'.format(opt.result)
251 self.result = self.opts[0].result
254 class AND(ComplexOptCheck):
255 # self.opts[0] is the option that this AND-check is about.
257 # AND(<suboption>, <main_option>)
258 # Suboption is not checked if checking of the main_option is failed.
259 # AND(<X_is_disabled>, <old_X_is_disabled>)
261 for i, opt in reversed(list(enumerate(self.opts))):
264 self.result = opt.result
266 if not opt.result.startswith('OK'):
267 # This FAIL is caused by additional checks,
268 # and not by the main option that this AND-check is about.
269 # Describe the reason of the FAIL.
270 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
271 self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
272 elif opt.result == 'FAIL: not present':
273 self.result = 'FAIL: {} not present'.format(opt.name)
275 # VersionCheck provides enough info
276 self.result = opt.result
277 assert(opt.result.startswith('FAIL: version')), \
278 'unexpected FAIL description "{}"'.format(opt.result)
282 def detect_arch(fname, archs):
283 with open(fname, 'r') as f:
284 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
286 for line in f.readlines():
287 if arch_pattern.match(line):
288 option, _ = line[7:].split('=', 1)
293 return None, 'more than one supported architecture is detected'
295 return None, 'failed to detect architecture'
299 def detect_version(fname):
300 with open(fname, 'r') as f:
301 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
302 for line in f.readlines():
303 if ver_pattern.match(line):
307 ver_numbers = ver_str.split('.')
308 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
309 msg = 'failed to parse the version "' + ver_str + '"'
311 return (int(ver_numbers[0]), int(ver_numbers[1])), None
312 return None, 'no kernel version detected'
315 def add_kconfig_checks(l, arch):
316 # Calling the KconfigCheck class constructor:
317 # KconfigCheck(reason, decision, name, expected)
319 modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
320 devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
321 bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
322 efi_not_set = KconfigCheck('cut_attack_surface', 'my', 'EFI', 'is not set')
324 # 'self_protection', 'defconfig'
325 l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
326 l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
327 l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
328 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
329 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'))]
330 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
331 KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
332 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
333 KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
334 l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
335 KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
336 modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
337 l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
338 VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
339 l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
340 iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
341 l += [iommu_support_is_set] # is needed for mitigating DMA attacks
342 if arch in ('X86_64', 'ARM64', 'X86_32'):
343 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
344 if arch in ('X86_64', 'ARM64'):
345 l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
346 if arch in ('X86_64', 'X86_32'):
347 l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
348 l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
349 l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
350 l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
351 l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
352 KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
353 if arch in ('ARM64', 'ARM'):
354 l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
356 l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
357 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
358 l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
359 iommu_support_is_set)]
360 l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
361 iommu_support_is_set)]
363 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
364 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
365 l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
366 l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
367 AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
368 VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
369 l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
370 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
371 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
372 l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
373 VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
374 l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
375 l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
376 l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
378 l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
379 l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
380 l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
382 # 'self_protection', 'kspp'
383 l += [KconfigCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
384 l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
385 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
386 l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
387 l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
388 l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
389 l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
390 l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
391 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
392 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
393 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
394 l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
395 l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
396 l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
397 l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
398 l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
399 l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
400 l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
401 randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
402 l += [randstruct_is_set]
403 hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
404 l += [hardened_usercopy_is_set]
405 l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
406 hardened_usercopy_is_set)]
407 l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
408 hardened_usercopy_is_set)]
409 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
411 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
413 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
415 l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
416 modules_not_set)] # refers to LOCKDOWN
417 l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
418 KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
419 l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
420 KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
421 # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
422 # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
423 # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
424 # the 0xAA poison pattern on allocation.
425 # That brings higher performance penalty.
426 if arch in ('X86_64', 'ARM64', 'X86_32'):
427 stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
428 l += [stackleak_is_set]
429 l += [OR(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
430 CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'))]
431 if arch in ('X86_64', 'X86_32'):
432 l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
433 l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
434 if arch in ('ARM64', 'ARM'):
435 l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
436 l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
438 l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
440 l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
441 l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
442 l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
444 # 'self_protection', 'maintainer'
445 ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
446 l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
447 if arch in ('X86_64', 'ARM64', 'X86_32'): # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
448 l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
449 ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
450 l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
451 ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
453 # 'self_protection', 'clipos'
454 l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
455 l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
456 l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
458 l += [OR(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
459 CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'))] # option presence check
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', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
522 l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
523 l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
524 l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
525 l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
526 l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
527 l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
528 l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
529 l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
530 l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
531 l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
532 l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
533 l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
534 l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
535 l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
536 l += [modules_not_set]
537 l += [devmem_not_set]
538 l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
539 devmem_not_set)] # refers to LOCKDOWN
541 l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
542 devmem_not_set)] # refers to LOCKDOWN
544 l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
546 # 'cut_attack_surface', 'grsec'
547 l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
548 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
549 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
550 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
551 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
552 l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
553 l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
554 l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
555 l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
556 l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
557 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
558 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
559 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
560 l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
561 l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
562 l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
563 l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
564 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
565 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
566 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
567 l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
568 l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
569 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
570 l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
571 l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
572 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
573 l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
574 l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
575 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
576 l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
577 l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
578 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
579 l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
580 l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
581 l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
582 l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
583 l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
584 l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
585 KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
587 # 'cut_attack_surface', 'maintainer'
588 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
589 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
590 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
591 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
592 l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
594 # 'cut_attack_surface', 'grapheneos'
595 l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
597 # 'cut_attack_surface', 'clipos'
598 l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
599 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
600 # l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
601 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
602 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
603 l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
604 l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
605 l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
606 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
607 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
608 l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
609 l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
610 l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
611 KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
612 if arch in ('X86_64', 'X86_32'):
613 l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
615 # 'cut_attack_surface', 'lockdown'
616 l += [bpf_syscall_not_set] # refers to LOCKDOWN
617 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
618 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
619 l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
621 # 'cut_attack_surface', 'my'
622 l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
624 l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
625 l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
626 l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
627 l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
628 l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
629 l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
630 l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
631 l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
634 if arch in ('X86_64', 'ARM64', 'X86_32'):
635 l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
637 l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
638 if arch in ('ARM', 'X86_32'):
639 l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
640 if arch in ('X86_64', 'ARM64'):
641 l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
642 if arch in ('X86_32', 'ARM'):
643 l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
645 # l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
648 def add_cmdline_checks(l, arch):
649 # Calling the CmdlineCheck class constructor:
650 # CmdlineCheck(reason, decision, name, expected)
652 l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
653 AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
654 CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
656 if arch in ('X86_64', 'X86_32'):
657 l += [CmdlineCheck('self_protection', 'kspp', 'pti', 'on')]
661 def print_unknown_options(checklist, parsed_options):
665 if o1.type != 'complex':
666 known_options.append(o1.name)
669 if o2.type != 'complex':
670 if hasattr(o2, 'name'):
671 known_options.append(o2.name)
674 assert(o3.type != 'complex'), \
675 'unexpected ComplexOptCheck inside {}'.format(o2.name)
676 if hasattr(o3, 'name'):
677 known_options.append(o3.name)
679 for option, value in parsed_options.items():
680 if option not in known_options:
681 print('[?] No check for option {} ({})'.format(option, value))
684 def print_checklist(mode, checklist, with_results):
688 output.append(o.json_dump(with_results))
689 print(json.dumps(output))
696 print('=' * sep_line_len)
697 print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
699 print('| {}'.format('check result'), end='')
701 print('=' * sep_line_len)
704 for opt in checklist:
706 if mode == 'show_ok':
707 if not opt.result.startswith('OK'):
709 if mode == 'show_fail':
710 if not opt.result.startswith('FAIL'):
712 opt.table_print(mode, with_results)
714 if mode == 'verbose':
715 print('-' * sep_line_len)
720 fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
722 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
724 if mode == 'show_ok':
725 fail_suppressed = ' (suppressed in output)'
726 if mode == 'show_fail':
727 ok_suppressed = ' (suppressed in output)'
729 print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
732 def populate_simple_opt_with_data(opt, data, data_type):
733 assert(opt.type != 'complex'), \
734 'unexpected ComplexOptCheck "{}"'.format(opt.name)
735 assert(opt.type in SIMPLE_OPTION_TYPES), \
736 'invalid opt type "{}"'.format(opt.type)
737 assert(data_type in SIMPLE_OPTION_TYPES), \
738 'invalid data type "{}"'.format(data_type)
740 if data_type != opt.type:
743 if data_type in ('kconfig', 'cmdline'):
744 opt.state = data.get(opt.name, None)
746 assert(data_type == 'version'), \
747 'unexpected data type "{}"'.format(data_type)
751 def populate_opt_with_data(opt, data, data_type):
752 if opt.type == 'complex':
754 if o.type == 'complex':
755 # Recursion for nested ComplexOptCheck objects
756 populate_opt_with_data(o, data, data_type)
758 populate_simple_opt_with_data(o, data, data_type)
760 assert(opt.type in ('kconfig', 'cmdline')), \
761 'bad type "{}" for a simple check'.format(opt.type)
762 populate_simple_opt_with_data(opt, data, data_type)
765 def populate_with_data(checklist, data, data_type):
766 for opt in checklist:
767 populate_opt_with_data(opt, data, data_type)
770 def perform_checks(checklist):
771 for opt in checklist:
775 def parse_kconfig_file(parsed_options, fname):
776 with open(fname, 'r') as f:
777 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
778 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
780 for line in f.readlines():
785 if opt_is_on.match(line):
786 option, value = line.split('=', 1)
787 elif opt_is_off.match(line):
788 option, value = line[2:].split(' ', 1)
789 if value != 'is not set':
790 sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
792 if option in parsed_options:
793 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
796 parsed_options[option] = value
799 def parse_cmdline_file(parsed_options, fname):
800 with open(fname, 'r') as f:
806 sys.exit('[!] ERROR: more than one line in "{}"'.format(fname))
810 name, value = opt.split('=', 1)
813 value = '' # '' is not None
814 parsed_options[name] = value
820 # - reporting about unknown kernel options in the kconfig
821 # - verbose printing of ComplexOptCheck items
822 # * json mode for printing the results in JSON format
823 report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
824 supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
825 parser = ArgumentParser(prog='kconfig-hardened-check',
826 description='A tool for checking the security hardening options of the Linux kernel')
827 parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
828 parser.add_argument('-p', '--print', choices=supported_archs,
829 help='print security hardening preferences for the selected architecture')
830 parser.add_argument('-c', '--config',
831 help='check the kernel kconfig file against these preferences')
832 parser.add_argument('-l', '--cmdline',
833 help='check the kernel cmdline file against these preferences')
834 parser.add_argument('-m', '--mode', choices=report_modes,
835 help='choose the report mode')
836 args = parser.parse_args()
842 print('[+] Special report mode: {}'.format(mode))
844 config_checklist = []
848 sys.exit('[!] ERROR: --config and --print can\'t be used together')
851 print('[+] Kconfig file to check: {}'.format(args.config))
853 print('[+] Kernel cmdline file to check: {}'.format(args.cmdline))
855 arch, msg = detect_arch(args.config, supported_archs)
857 sys.exit('[!] ERROR: {}'.format(msg))
859 print('[+] Detected architecture: {}'.format(arch))
861 kernel_version, msg = detect_version(args.config)
862 if not kernel_version:
863 sys.exit('[!] ERROR: {}'.format(msg))
865 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
867 # add relevant kconfig checks to the checklist
868 add_kconfig_checks(config_checklist, arch)
871 # add relevant cmdline checks to the checklist
872 add_cmdline_checks(config_checklist, arch)
874 # populate the checklist with the parsed kconfig data
875 parsed_kconfig_options = OrderedDict()
876 parse_kconfig_file(parsed_kconfig_options, args.config)
877 populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
878 populate_with_data(config_checklist, kernel_version, 'version')
881 # populate the checklist with the parsed kconfig data
882 parsed_cmdline_options = OrderedDict()
883 parse_cmdline_file(parsed_cmdline_options, args.cmdline)
884 populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
886 # now everything is ready for performing the checks
887 perform_checks(config_checklist)
889 # finally print the results
890 if mode == 'verbose':
891 print_unknown_options(config_checklist, parsed_kconfig_options)
892 print_checklist(mode, config_checklist, True)
896 sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking kconfig')
899 if mode in ('show_ok', 'show_fail'):
900 sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
902 add_kconfig_checks(config_checklist, arch)
903 add_cmdline_checks(config_checklist, arch)
905 print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
906 print_checklist(mode, config_checklist, False)