4 # This script 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 # kernel.kptr_restrict=1
17 # page_alloc.shuffle=1
18 # iommu=force (does it help against DMA attacks?)
19 # page_poison=1 (if enabled)
24 # Mitigations of CPU vulnerabilities:
26 # mitigations=auto,nosmt
30 # spec_store_bypass_disable=on
37 # N.B. Hardening sysctls:
38 # net.core.bpf_jit_harden=2
40 # vm.unprivileged_userfaultfd=0
41 # kernel.perf_event_paranoid=3
42 # kernel.yama.ptrace_scope=1 (or even 3?)
43 # kernel.unprivileged_bpf_disabled=1
45 # fs.protected_symlinks = 1
46 # fs.protected_hardlinks = 1
47 # fs.protected_fifos = 2
48 # fs.protected_regular = 2
51 from argparse import ArgumentParser
52 from collections import OrderedDict
57 # - reporting about unknown kernel options in the config,
58 # - verbose printing of ComplexOptChecks (OR, AND).
61 # json_mode is for printing results in JSON format
64 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
70 def __init__(self, name, expected, decision, reason):
72 self.expected = expected
73 self.decision = decision
79 if self.expected == self.state:
81 elif self.state is None:
82 if self.expected == 'is not set':
83 self.result = 'OK: not found'
85 self.result = 'FAIL: not found'
87 self.result = 'FAIL: "' + self.state + '"'
89 if self.result.startswith('OK'):
90 return True, self.result
92 return False, self.result
96 def __init__(self, ver_expected):
97 self.ver_expected = ver_expected
101 if kernel_version[0] > self.ver_expected[0]:
102 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
103 return True, self.result
104 if kernel_version[0] < self.ver_expected[0]:
105 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
106 return False, self.result
107 if kernel_version[1] >= self.ver_expected[1]:
108 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
109 return True, self.result
111 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
112 return False, self.result
115 class ComplexOptCheck:
116 def __init__(self, *opts):
122 return self.opts[0].name
126 return self.opts[0].expected
130 return self.opts[0].state
134 return self.opts[0].decision
138 return self.opts[0].reason
141 class OR(ComplexOptCheck):
142 # self.opts[0] is the option that this OR-check is about.
144 # OR(<X_is_hardened>, <X_is_disabled>)
145 # OR(<X_is_hardened>, <X_is_hardened_old>)
149 sys.exit('[!] ERROR: invalid OR check')
151 for i, opt in enumerate(self.opts):
152 ret, msg = opt.check()
154 if i == 0 or not hasattr(opt, 'name'):
155 self.result = opt.result
157 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
158 return True, self.result
159 self.result = self.opts[0].result
160 return False, self.result
163 class AND(ComplexOptCheck):
164 # self.opts[0] is the option that this AND-check is about.
165 # Use case: AND(<suboption>, <main_option>)
166 # Suboption is not checked if checking of the main_option is failed.
169 for i, opt in reversed(list(enumerate(self.opts))):
170 ret, msg = opt.check()
172 self.result = opt.result
173 return ret, self.result
175 if hasattr(opt, 'name'):
176 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
178 self.result = opt.result
179 return False, self.result
181 sys.exit('[!] ERROR: invalid AND check')
184 def detect_arch(fname):
185 with open(fname, 'r') as f:
186 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
189 print('[+] Trying to detect architecture in "{}"...'.format(fname))
190 for line in f.readlines():
191 if arch_pattern.match(line):
192 option, value = line[7:].split('=', 1)
193 if option in supported_archs:
197 return None, 'more than one supported architecture is detected'
199 return None, 'failed to detect architecture'
204 def detect_version(fname):
205 with open(fname, 'r') as f:
206 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
208 print('[+] Trying to detect kernel version in "{}"...'.format(fname))
209 for line in f.readlines():
210 if ver_pattern.match(line):
213 print('[+] Found version line: "{}"'.format(line))
216 ver_numbers = ver_str.split('.')
217 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
218 msg = 'failed to parse the version "' + ver_str + '"'
221 return (int(ver_numbers[0]), int(ver_numbers[1])), None
222 return None, 'no kernel version detected'
225 def construct_checklist(checklist, arch):
226 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
227 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCKDOWN
229 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
230 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
231 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
232 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
233 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
234 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
235 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
236 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
237 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
238 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'defconfig', 'self_protection'))
239 checklist.append(OR(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'), \
240 VerCheck((5, 5)))) # REFCOUNT_FULL is enabled by default since v5.5
241 iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'defconfig', 'self_protection') # is needed for mitigating DMA attacks
242 checklist.append(iommu_support_is_set)
243 if arch == 'X86_64' or arch == 'X86_32':
244 checklist.append(OptCheck('MICROCODE', 'y', 'defconfig', 'self_protection')) # is needed for mitigating CPU bugs
245 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
246 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
247 checklist.append(OR(OptCheck('X86_UMIP', 'y', 'defconfig', 'self_protection'), \
248 OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection')))
249 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
251 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
252 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
253 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'defconfig', 'self_protection'), \
254 iommu_support_is_set))
255 checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'defconfig', 'self_protection'), \
256 iommu_support_is_set))
258 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
259 checklist.append(OptCheck('HARDEN_EL2_VECTORS', 'y', 'defconfig', 'self_protection'))
260 checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
261 if arch == 'X86_64' or arch == 'ARM64':
262 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
263 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
264 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
265 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
267 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
268 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'defconfig', 'self_protection'))
269 if arch == 'ARM64' or arch == 'ARM':
270 checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))
272 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
273 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
274 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
275 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
276 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
277 checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
278 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
279 randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
280 checklist.append(randstruct_is_set)
281 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
282 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
283 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
284 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
285 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
286 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
287 checklist.append(hardened_usercopy_is_set)
288 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
289 hardened_usercopy_is_set))
290 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
292 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
294 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
296 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
297 modules_not_set)) # refers to LOCKDOWN
298 checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'kspp', 'self_protection'), \
299 OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
300 checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON', 'y', 'kspp', 'self_protection'))
301 checklist.append(OR(OptCheck('INIT_ON_FREE_DEFAULT_ON', 'y', 'kspp', 'self_protection'), \
302 OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection'))) # before v5.3
303 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
304 stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'kspp', 'self_protection')
305 checklist.append(stackleak_is_set)
306 checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
308 checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
310 if arch == 'X86_64' or arch == 'X86_32':
311 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
313 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'kspp', 'self_protection'))
314 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
315 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
317 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
318 if arch == 'ARM64' or arch == 'ARM':
319 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
320 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
322 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
323 checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
324 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
325 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
326 checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
328 checklist.append(OptCheck('RANDOM_TRUST_BOOTLOADER', 'is not set', 'clipos', 'self_protection'))
329 checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
330 if arch == 'X86_64' or arch == 'X86_32':
331 checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
332 iommu_support_is_set))
333 checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
334 iommu_support_is_set))
336 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'clipos', 'self_protection'), \
337 iommu_support_is_set))
339 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
340 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
342 checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
343 iommu_support_is_set))
345 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
346 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
348 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
349 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
350 checklist.append(OR(OptCheck('SECURITY_WRITABLE_HOOKS', 'is not set', 'my', 'security_policy'), \
351 OptCheck('SECURITY_SELINUX_DISABLE', 'is not set', 'kspp', 'security_policy')))
352 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM', 'y', 'clipos', 'security_policy'))
353 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM_EARLY', 'y', 'clipos', 'security_policy'))
354 checklist.append(OptCheck('LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y', 'clipos', 'security_policy'))
355 loadpin_is_set = OptCheck('SECURITY_LOADPIN', 'y', 'my', 'security_policy') # needs userspace support
356 checklist.append(loadpin_is_set)
357 checklist.append(AND(OptCheck('SECURITY_LOADPIN_ENFORCE', 'y', 'my', 'security_policy'), \
359 checklist.append(OptCheck('SECURITY_SAFESETID', 'y', 'my', 'security_policy'))
361 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
362 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
363 if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
364 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
365 devmem_not_set)) # refers to LOCKDOWN
367 checklist.append(modules_not_set)
368 checklist.append(devmem_not_set)
369 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
370 devmem_not_set)) # refers to LOCKDOWN
372 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
373 devmem_not_set)) # refers to LOCKDOWN
375 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
376 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
377 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
378 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
379 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
380 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
381 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
382 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
383 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
384 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
385 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCKDOWN
386 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
387 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
388 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
389 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
391 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
392 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
393 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
394 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
395 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
396 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
397 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
398 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
399 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
400 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
401 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
402 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
403 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
404 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
405 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
406 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
407 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
408 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
410 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
411 checklist.append(OptCheck('X86_IOPL_IOPERM', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
412 checklist.append(OptCheck('EFI_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
413 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
414 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
416 checklist.append(OptCheck('STAGING', 'is not set', 'clipos', 'cut_attack_surface'))
417 checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
418 # checklist.append(OptCheck('IKCONFIG', 'is not set', 'clipos', 'cut_attack_surface')) # no, this info is needed for this check :)
419 checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
420 checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
421 checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
422 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCKDOWN (permissive)
423 checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
424 checklist.append(OptCheck('X86_MSR', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCKDOWN
425 checklist.append(OptCheck('X86_CPUID', 'is not set', 'clipos', 'cut_attack_surface'))
426 checklist.append(AND(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'), \
427 VerCheck((5, 1)))) # LDISC_AUTOLOAD can be disabled since v5.1
429 checklist.append(OptCheck('AIO', 'is not set', 'grapheneos', 'cut_attack_surface'))
431 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCKDOWN (permissive)
432 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
433 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
434 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
435 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCKDOWN
436 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
437 checklist.append(OptCheck('VIDEO_VIVID', 'is not set', 'my', 'cut_attack_surface'))
439 checklist.append(OptCheck('INTEGRITY', 'y', 'defconfig', 'userspace_hardening'))
441 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_hardening'))
442 if arch == 'ARM' or arch == 'X86_32':
443 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'userspace_hardening'))
444 if arch == 'X86_64' or arch == 'ARM64':
445 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_hardening'))
446 if arch == 'X86_32' or arch == 'ARM':
447 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_hardening'))
449 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
452 def print_opt(opt, with_results):
453 print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
455 print('| {}'.format(opt.result), end='')
459 def print_checklist(checklist, with_results):
463 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
467 print(json.dumps(opts))
474 print('=' * sep_line_len)
475 print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
477 print('| {}'.format('check result'), end='')
479 print('=' * sep_line_len)
482 for opt in checklist:
483 if debug_mode and hasattr(opt, 'opts'):
484 print(' {:87}'.format('<<< ' + opt.__class__.__name__ + ' >>>'), end='')
486 print('| {}'.format(opt.result), end='')
489 if hasattr(o, 'ver_expected'):
490 ver_req = 'kernel version >= ' + str(o.ver_expected[0]) + '.' + str(o.ver_expected[1])
491 print('{:<91}'.format(ver_req), end='')
493 print('| {}'.format(o.result), end='')
496 print_opt(o, with_results)
498 print_opt(opt, with_results)
500 print('-' * sep_line_len)
504 def perform_checks(checklist, parsed_options):
505 for opt in checklist:
506 if hasattr(opt, 'opts'):
507 # prepare ComplexOptCheck
509 if hasattr(o, 'name'):
510 o.state = parsed_options.get(o.name, None)
512 # prepare simple OptCheck
513 if not hasattr(opt, 'name'):
514 sys.exit('[!] ERROR: bad OptCheck {}'.format(vars(opt)))
515 opt.state = parsed_options.get(opt.name, None)
519 def check_config_file(checklist, fname):
520 with open(fname, 'r') as f:
521 parsed_options = OrderedDict()
522 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
523 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
526 print('[+] Checking "{}" against {} hardening preferences...'.format(fname, arch))
527 for line in f.readlines():
532 if opt_is_on.match(line):
533 option, value = line[7:].split('=', 1)
534 elif opt_is_off.match(line):
535 option, value = line[9:].split(' ', 1)
536 if value != 'is not set':
537 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
539 if option in parsed_options:
540 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
542 if option is not None:
543 parsed_options[option] = value
545 perform_checks(checklist, parsed_options)
549 for opt in checklist:
550 if hasattr(opt, 'opts'):
552 if hasattr(o, 'name'):
553 known_options.append(o.name)
555 known_options.append(opt.name)
556 for option, value in parsed_options.items():
557 if option not in known_options:
558 print('DEBUG: dunno about option {} ({})'.format(option, value))
560 print_checklist(checklist, True)
563 if __name__ == '__main__':
564 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
565 parser.add_argument('-p', '--print', choices=supported_archs,
566 help='print hardening preferences for selected architecture')
567 parser.add_argument('-c', '--config',
568 help='check the config_file against these preferences')
569 parser.add_argument('--debug', action='store_true',
570 help='enable verbose debug mode')
571 parser.add_argument('--json', action='store_true',
572 help='print results in JSON format')
573 args = parser.parse_args()
577 print('[!] WARNING: debug mode is enabled')
580 if debug_mode and json_mode:
581 sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
584 arch, msg = detect_arch(args.config)
586 sys.exit('[!] ERROR: {}'.format(msg))
588 print('[+] Detected architecture: {}'.format(arch))
590 kernel_version, msg = detect_version(args.config)
591 if not kernel_version:
592 sys.exit('[!] ERROR: {}'.format(msg))
594 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
596 construct_checklist(config_checklist, arch)
597 check_config_file(config_checklist, args.config)
598 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
599 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
603 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
608 construct_checklist(config_checklist, arch)
610 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
611 print_checklist(config_checklist, False)