4 # This tool helps me to check the Linux kernel Kconfig option list
5 # against my hardening preferences for X86_64, ARM64, X86_32, and ARM.
6 # Let the computers do their job!
8 # Author: Alexander Popov <alex.popov@linux.com>
10 # Please don't cry if my Python code looks like C.
13 # N.B Hardening command line parameters:
16 # page_alloc.shuffle=1
17 # iommu=force (does it help against DMA attacks?)
18 # page_poison=1 (if enabled)
23 # Mitigations of CPU vulnerabilities:
25 # mitigations=auto,nosmt
29 # spec_store_bypass_disable=on
37 # N.B. Hardening sysctls:
38 # kernel.kptr_restrict=2
39 # kernel.dmesg_restrict=1
40 # kernel.perf_event_paranoid=3
41 # kernel.kexec_load_disabled=1
42 # kernel.yama.ptrace_scope=3
43 # user.max_user_namespaces=0
44 # kernel.unprivileged_bpf_disabled=1
45 # net.core.bpf_jit_harden=2
47 # vm.unprivileged_userfaultfd=0
49 # dev.tty.ldisc_autoload=0
50 # fs.protected_symlinks=1
51 # fs.protected_hardlinks=1
52 # fs.protected_fifos=2
53 # fs.protected_regular=2
55 # kernel.modules_disabled=1
58 from argparse import ArgumentParser
59 from collections import OrderedDict
64 # - reporting about unknown kernel options in the config,
65 # - verbose printing of ComplexOptChecks (OR, AND).
68 # json_mode is for printing results in JSON format
71 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
77 def __init__(self, name, expected, decision, reason):
79 self.expected = expected
80 self.decision = decision
86 if self.expected == self.state:
88 elif self.state is None:
89 if self.expected == 'is not set':
90 self.result = 'OK: not found'
92 self.result = 'FAIL: not found'
94 self.result = 'FAIL: "' + self.state + '"'
96 if self.result.startswith('OK'):
97 return True, self.result
99 return False, self.result
101 def table_print(self, with_results):
102 print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(self.name, self.expected, self.decision, self.reason), end='')
104 print('| {}'.format(self.result), end='')
108 def __init__(self, ver_expected):
109 self.ver_expected = ver_expected
113 if kernel_version[0] > self.ver_expected[0]:
114 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
115 return True, self.result
116 if kernel_version[0] < self.ver_expected[0]:
117 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
118 return False, self.result
119 if kernel_version[1] >= self.ver_expected[1]:
120 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
121 return True, self.result
123 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
124 return False, self.result
126 def table_print(self, with_results):
127 ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
128 print('{:<91}'.format(ver_req), end='')
130 print('| {}'.format(self.result), end='')
134 def __init__(self, name):
140 if self.state is None:
141 self.result = 'FAIL: not present'
142 return False, self.result
144 self.result = 'OK: is present'
145 return True, self.result
147 def table_print(self, with_results):
148 print('CONFIG_{:<84}'.format(self.name + ' is present'), end='')
150 print('| {}'.format(self.result), end='')
153 class ComplexOptCheck:
154 def __init__(self, *opts):
160 return self.opts[0].name
164 return self.opts[0].expected
168 return self.opts[0].state
172 return self.opts[0].decision
176 return self.opts[0].reason
178 def table_print(self, with_results):
180 print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
182 print('| {}'.format(self.result), end='')
185 o.table_print(with_results)
190 print('| {}'.format(self.result), end='')
193 class OR(ComplexOptCheck):
194 # self.opts[0] is the option that this OR-check is about.
196 # OR(<X_is_hardened>, <X_is_disabled>)
197 # OR(<X_is_hardened>, <X_is_hardened_old>)
201 sys.exit('[!] ERROR: invalid OR check')
203 for i, opt in enumerate(self.opts):
204 ret, msg = opt.check()
206 if i == 0 or not hasattr(opt, 'expected'):
207 self.result = opt.result
209 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
210 return True, self.result
211 self.result = self.opts[0].result
212 return False, self.result
215 class AND(ComplexOptCheck):
216 # self.opts[0] is the option that this AND-check is about.
217 # Use case: AND(<suboption>, <main_option>)
218 # Suboption is not checked if checking of the main_option is failed.
221 for i, opt in reversed(list(enumerate(self.opts))):
222 ret, msg = opt.check()
224 self.result = opt.result
225 return ret, self.result
227 if hasattr(opt, 'expected'):
228 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
230 self.result = opt.result
231 return False, self.result
233 sys.exit('[!] ERROR: invalid AND check')
236 def detect_arch(fname):
237 with open(fname, 'r') as f:
238 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
241 print('[+] Trying to detect architecture in "{}"...'.format(fname))
242 for line in f.readlines():
243 if arch_pattern.match(line):
244 option, value = line[7:].split('=', 1)
245 if option in supported_archs:
249 return None, 'more than one supported architecture is detected'
251 return None, 'failed to detect architecture'
256 def detect_version(fname):
257 with open(fname, 'r') as f:
258 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
260 print('[+] Trying to detect kernel version in "{}"...'.format(fname))
261 for line in f.readlines():
262 if ver_pattern.match(line):
265 print('[+] Found version line: "{}"'.format(line))
268 ver_numbers = ver_str.split('.')
269 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
270 msg = 'failed to parse the version "' + ver_str + '"'
273 return (int(ver_numbers[0]), int(ver_numbers[1])), None
274 return None, 'no kernel version detected'
277 def construct_checklist(checklist, arch):
278 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
279 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCKDOWN
281 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
282 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
283 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
284 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
285 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
286 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
287 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
288 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
289 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
290 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'defconfig', 'self_protection'))
291 checklist.append(OR(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'), \
292 VerCheck((5, 5)))) # REFCOUNT_FULL is enabled by default since v5.5
293 iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'defconfig', 'self_protection') # is needed for mitigating DMA attacks
294 checklist.append(iommu_support_is_set)
295 if arch == 'X86_64' or arch == 'X86_32':
296 checklist.append(OptCheck('MICROCODE', 'y', 'defconfig', 'self_protection')) # is needed for mitigating CPU bugs
297 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
298 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
299 checklist.append(OR(OptCheck('X86_UMIP', 'y', 'defconfig', 'self_protection'), \
300 OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection')))
301 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
303 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
304 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
305 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'defconfig', 'self_protection'), \
306 iommu_support_is_set))
307 checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'defconfig', 'self_protection'), \
308 iommu_support_is_set))
310 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
311 checklist.append(OptCheck('HARDEN_EL2_VECTORS', 'y', 'defconfig', 'self_protection'))
312 checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
313 if arch == 'X86_64' or arch == 'ARM64':
314 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
315 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
316 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
317 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
319 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
320 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'defconfig', 'self_protection'))
321 if arch == 'ARM64' or arch == 'ARM':
322 checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))
324 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
325 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
326 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
327 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
328 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
329 checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
330 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
331 randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
332 checklist.append(randstruct_is_set)
333 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
334 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
335 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
336 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
337 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
338 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
339 checklist.append(hardened_usercopy_is_set)
340 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
341 hardened_usercopy_is_set))
342 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
344 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
346 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
348 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
349 modules_not_set)) # refers to LOCKDOWN
350 checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'kspp', 'self_protection'), \
351 OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
352 checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON', 'y', 'kspp', 'self_protection'))
353 checklist.append(OR(OptCheck('INIT_ON_FREE_DEFAULT_ON', 'y', 'kspp', 'self_protection'), \
354 OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection'))) # before v5.3
355 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
356 stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'kspp', 'self_protection')
357 checklist.append(stackleak_is_set)
358 checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
360 checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
362 if arch == 'X86_64' or arch == 'X86_32':
363 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
365 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'kspp', 'self_protection'))
366 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
367 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
369 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
370 if arch == 'ARM64' or arch == 'ARM':
371 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
372 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
374 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
375 checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
376 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
377 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
378 checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
380 checklist.append(OptCheck('RANDOM_TRUST_BOOTLOADER', 'is not set', 'clipos', 'self_protection'))
381 checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
382 if arch == 'X86_64' or arch == 'X86_32':
383 checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
384 iommu_support_is_set))
385 checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
386 iommu_support_is_set))
388 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'clipos', 'self_protection'), \
389 iommu_support_is_set))
391 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
392 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
394 checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
395 iommu_support_is_set))
397 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
398 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
400 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
401 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
402 checklist.append(OR(OptCheck('SECURITY_WRITABLE_HOOKS', 'is not set', 'my', 'security_policy'), \
403 OptCheck('SECURITY_SELINUX_DISABLE', 'is not set', 'kspp', 'security_policy')))
404 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM', 'y', 'clipos', 'security_policy'))
405 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM_EARLY', 'y', 'clipos', 'security_policy'))
406 checklist.append(OptCheck('LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y', 'clipos', 'security_policy'))
407 loadpin_is_set = OptCheck('SECURITY_LOADPIN', 'y', 'my', 'security_policy') # needs userspace support
408 checklist.append(loadpin_is_set)
409 checklist.append(AND(OptCheck('SECURITY_LOADPIN_ENFORCE', 'y', 'my', 'security_policy'), \
411 checklist.append(OptCheck('SECURITY_SAFESETID', 'y', 'my', 'security_policy'))
413 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
414 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
415 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
416 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
417 devmem_not_set)) # refers to LOCKDOWN
419 checklist.append(modules_not_set)
420 checklist.append(devmem_not_set)
421 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
422 devmem_not_set)) # refers to LOCKDOWN
424 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
425 devmem_not_set)) # refers to LOCKDOWN
427 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
428 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
429 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
430 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
431 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
432 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
433 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
434 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
435 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
436 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
437 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
438 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
439 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
440 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
441 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
443 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
444 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
445 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
446 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
447 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
448 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
449 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
450 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
451 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
452 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
453 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
454 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
455 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
456 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
457 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
458 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
459 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
460 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
462 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
463 checklist.append(OptCheck('X86_IOPL_IOPERM', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
464 checklist.append(OptCheck('EFI_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
465 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
466 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
468 if arch == 'X86_64' or arch == 'X86_32':
469 checklist.append(OptCheck('X86_INTEL_TSX_MODE_OFF', 'y', 'clipos', 'cut_attack_surface')) # tsx=off
470 checklist.append(OptCheck('STAGING', 'is not set', 'clipos', 'cut_attack_surface'))
471 checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
472 # checklist.append(OptCheck('IKCONFIG', 'is not set', 'clipos', 'cut_attack_surface')) # no, this info is needed for this check :)
473 checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
474 checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
475 checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
476 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCKDOWN (permissive)
477 checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
478 checklist.append(OptCheck('X86_MSR', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCKDOWN
479 checklist.append(OptCheck('X86_CPUID', 'is not set', 'clipos', 'cut_attack_surface'))
480 checklist.append(AND(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'), \
481 PresenceCheck('LDISC_AUTOLOAD')))
483 checklist.append(OptCheck('AIO', 'is not set', 'grapheneos', 'cut_attack_surface'))
485 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCKDOWN (permissive)
486 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
487 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
488 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
489 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCKDOWN
490 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
491 checklist.append(OptCheck('VIDEO_VIVID', 'is not set', 'my', 'cut_attack_surface'))
493 checklist.append(OptCheck('INTEGRITY', 'y', 'defconfig', 'userspace_hardening'))
495 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_hardening'))
496 if arch == 'ARM' or arch == 'X86_32':
497 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'userspace_hardening'))
498 if arch == 'X86_64' or arch == 'ARM64':
499 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_hardening'))
500 if arch == 'X86_32' or arch == 'ARM':
501 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_hardening'))
503 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
506 def print_checklist(checklist, with_results):
510 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
514 print(json.dumps(opts))
521 print('=' * sep_line_len)
522 print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
524 print('| {}'.format('check result'), end='')
526 print('=' * sep_line_len)
529 for opt in checklist:
530 opt.table_print(with_results)
533 print('-' * sep_line_len)
537 def perform_checks(checklist, parsed_options):
538 for opt in checklist:
539 if hasattr(opt, 'opts'):
540 # prepare ComplexOptCheck
542 if hasattr(o, 'state'):
543 o.state = parsed_options.get(o.name, None)
545 # prepare simple check
546 if not hasattr(opt, 'state'):
547 sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
548 opt.state = parsed_options.get(opt.name, None)
552 def check_config_file(checklist, fname, arch):
553 with open(fname, 'r') as f:
554 parsed_options = OrderedDict()
555 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
556 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
559 print('[+] Checking "{}" against {} hardening preferences...'.format(fname, arch))
560 for line in f.readlines():
565 if opt_is_on.match(line):
566 option, value = line[7:].split('=', 1)
567 elif opt_is_off.match(line):
568 option, value = line[9:].split(' ', 1)
569 if value != 'is not set':
570 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
572 if option in parsed_options:
573 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
575 if option is not None:
576 parsed_options[option] = value
578 perform_checks(checklist, parsed_options)
582 for opt in checklist:
583 if hasattr(opt, 'opts'):
585 if hasattr(o, 'name'):
586 known_options.append(o.name)
588 known_options.append(opt.name)
589 for option, value in parsed_options.items():
590 if option not in known_options:
591 print('DEBUG: dunno about option {} ({})'.format(option, value))
593 print_checklist(checklist, True)
598 global kernel_version
600 config_checklist = []
602 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
603 parser.add_argument('-p', '--print', choices=supported_archs,
604 help='print hardening preferences for selected architecture')
605 parser.add_argument('-c', '--config',
606 help='check the config_file against these preferences')
607 parser.add_argument('--debug', action='store_true',
608 help='enable verbose debug mode')
609 parser.add_argument('--json', action='store_true',
610 help='print results in JSON format')
611 args = parser.parse_args()
615 print('[!] WARNING: debug mode is enabled')
618 if debug_mode and json_mode:
619 sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
622 arch, msg = detect_arch(args.config)
624 sys.exit('[!] ERROR: {}'.format(msg))
626 print('[+] Detected architecture: {}'.format(arch))
628 kernel_version, msg = detect_version(args.config)
629 if not kernel_version:
630 sys.exit('[!] ERROR: {}'.format(msg))
632 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
634 construct_checklist(config_checklist, arch)
635 check_config_file(config_checklist, args.config, arch)
636 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
637 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
638 if not debug_mode and not json_mode:
639 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
644 construct_checklist(config_checklist, arch)
646 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
647 print_checklist(config_checklist, False)
653 if __name__ == '__main__':