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 # lockdown=1 (is it changed?)
18 # page_alloc.shuffle=1
19 # iommu=force (does it help against DMA attacks?)
20 # page_poison=1 (if enabled)
22 # Mitigations of CPU vulnerabilities:
24 # mitigations=auto,nosmt
28 # spec_store_bypass_disable=on
35 # N.B. Hardening sysctls:
36 # net.core.bpf_jit_harden=2
38 # vm.unprivileged_userfaultfd=0
39 # kernel.perf_event_paranoid=3
40 # kernel.yama.ptrace_scope=1 (or even 3?)
41 # kernel.unprivileged_bpf_disabled=1
43 # fs.protected_symlinks = 1
44 # fs.protected_hardlinks = 1
45 # fs.protected_fifos = 2
46 # fs.protected_regular = 2
49 from argparse import ArgumentParser
50 from collections import OrderedDict
54 debug_mode = False # set it to True to print the unknown options from the config
55 json_mode = False # if True, print results in JSON format
57 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
63 def __init__(self, name, expected, decision, reason):
65 self.expected = expected
66 self.decision = decision
72 if self.expected == self.state:
74 elif self.state is None:
75 if self.expected == 'is not set':
76 self.result = 'OK: not found'
78 self.result = 'FAIL: not found'
80 self.result = 'FAIL: "' + self.state + '"'
82 if self.result.startswith('OK'):
83 return True, self.result
85 return False, self.result
88 return '{} = {}'.format(self.name, self.state)
92 def __init__(self, ver_expected):
93 self.ver_expected = ver_expected
97 if kernel_version[0] > self.ver_expected[0]:
98 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
99 return True, self.result
100 if kernel_version[0] < self.ver_expected[0]:
101 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
102 return False, self.result
103 if kernel_version[1] >= self.ver_expected[1]:
104 self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
105 return True, self.result
107 self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
108 return False, self.result
111 class ComplexOptCheck:
112 def __init__(self, *opts):
118 return self.opts[0].name
122 return self.opts[0].expected
126 return self.opts[0].state
130 return self.opts[0].decision
134 return self.opts[0].reason
137 class OR(ComplexOptCheck):
138 # self.opts[0] is the option which this OR-check is about.
140 # OR(<X_is_hardened>, <X_is_disabled>)
141 # OR(<X_is_hardened>, <X_is_hardened_old>)
145 sys.exit('[!] ERROR: invalid OR check')
147 for i, opt in enumerate(self.opts):
148 ret, msg = opt.check()
150 if i == 0 or not hasattr(opt, 'name'):
151 self.result = opt.result
153 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
154 return True, self.result
155 self.result = self.opts[0].result
156 return False, self.result
159 class AND(ComplexOptCheck):
160 # self.opts[0] is the option which this AND-check is about.
161 # Use case: AND(<suboption>, <main_option>)
162 # Suboption is not checked if checking of the main_option is failed.
165 for i, opt in reversed(list(enumerate(self.opts))):
166 ret, msg = opt.check()
168 self.result = opt.result
169 return ret, self.result
171 if hasattr(opt, 'name'):
172 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
174 self.result = opt.result
175 return False, self.result
177 sys.exit('[!] ERROR: invalid AND check')
180 def detect_arch(fname):
181 with open(fname, 'r') as f:
182 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
185 print('[+] Trying to detect architecture in "{}"...'.format(fname))
186 for line in f.readlines():
187 if arch_pattern.match(line):
188 option, value = line[7:].split('=', 1)
189 if option in supported_archs:
193 return None, 'more than one supported architecture is detected'
195 return None, 'failed to detect architecture'
200 def detect_version(fname):
201 with open(fname, 'r') as f:
202 ver_pattern = re.compile("# Linux/.* Kernel Configuration")
204 print('[+] Trying to detect kernel version in "{}"...'.format(fname))
205 for line in f.readlines():
206 if ver_pattern.match(line):
209 print('[+] Found version line: "{}"'.format(line))
212 ver_numbers = ver_str.split('.')
213 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
214 msg = 'failed to parse the version "' + ver_str + '"'
217 return (int(ver_numbers[0]), int(ver_numbers[1])), None
218 return None, 'no kernel version detected'
221 def construct_checklist(checklist, arch):
222 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
223 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
225 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
226 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
227 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
228 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
229 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
230 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
231 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
232 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
233 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
234 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'defconfig', 'self_protection'))
235 checklist.append(OR(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'), \
236 VerCheck((5, 5)))) # REFCOUNT_FULL is enabled by default since v5.5
237 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
238 checklist.append(OptCheck('MICROCODE', 'y', 'defconfig', 'self_protection')) # is needed for mitigating CPU bugs
239 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
240 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
241 checklist.append(OR(OptCheck('X86_UMIP', 'y', 'defconfig', 'self_protection'), \
242 OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection')))
243 iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'defconfig', 'self_protection') # is needed for mitigating DMA attacks
244 checklist.append(iommu_support_is_set)
245 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
246 if debug_mode or arch == 'X86_64':
247 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
248 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
249 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'defconfig', 'self_protection'), \
250 iommu_support_is_set))
251 checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'defconfig', 'self_protection'), \
252 iommu_support_is_set))
253 if debug_mode or arch == 'ARM64':
254 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
255 checklist.append(OptCheck('HARDEN_EL2_VECTORS', 'y', 'defconfig', 'self_protection'))
256 checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
257 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
258 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
259 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
260 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
261 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
262 if debug_mode or arch == 'ARM':
263 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'self_protection'))
264 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
265 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'defconfig', 'self_protection'))
266 if debug_mode or arch == 'ARM64' or arch == 'ARM':
267 checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))
269 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
270 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
271 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
272 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
273 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
274 checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
275 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
276 randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
277 checklist.append(randstruct_is_set)
278 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
279 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
280 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
281 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
282 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
283 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
284 checklist.append(hardened_usercopy_is_set)
285 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
286 hardened_usercopy_is_set))
287 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
289 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
291 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
293 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
294 modules_not_set)) # refers to LOCK_DOWN_KERNEL
295 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
296 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
297 if debug_mode or arch == 'X86_32':
298 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
299 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
300 if debug_mode or arch == 'ARM64':
301 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
302 if debug_mode or arch == 'ARM64' or arch == 'ARM':
303 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
304 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
306 checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'clipos', 'self_protection'), \
307 OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
308 checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON', 'y', 'clipos', 'self_protection'))
309 checklist.append(OR(OptCheck('INIT_ON_FREE_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
310 OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection')))
311 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
312 checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
313 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
314 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
315 checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
317 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
318 stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'clipos', 'self_protection')
319 checklist.append(stackleak_is_set)
320 checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
322 checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
324 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
325 checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
326 checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
327 iommu_support_is_set))
328 checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
329 iommu_support_is_set))
331 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
332 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
333 if debug_mode or arch == 'X86_64':
334 checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
335 iommu_support_is_set))
336 if debug_mode or arch == 'X86_32':
337 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
339 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
340 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
341 if debug_mode or arch == 'ARM':
342 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
343 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
344 checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'security_policy')) # needs userspace support
345 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM', 'y', 'my', 'security_policy'))
346 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM_EARLY', 'y', 'my', 'security_policy'))
347 checklist.append(OptCheck('LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y', 'my', 'security_policy'))
348 checklist.append(OptCheck('SECURITY_SAFESETID', 'y', 'my', 'security_policy'))
349 checklist.append(OptCheck('SECURITY_WRITABLE_HOOKS', 'is not set', 'my', 'security_policy'))
351 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
352 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
353 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
354 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
355 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
357 checklist.append(modules_not_set)
358 checklist.append(devmem_not_set)
359 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
360 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
361 if debug_mode or arch == 'ARM':
362 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
363 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
364 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
365 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
366 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface'))
367 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
368 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
369 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
370 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
371 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
372 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
373 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
374 if debug_mode or arch == 'X86_64':
375 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
376 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
377 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
378 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
379 if debug_mode or arch == 'ARM':
380 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
382 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
383 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
384 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
385 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
386 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
387 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
388 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
389 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface'))
390 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
391 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
392 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
393 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
394 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
395 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
396 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
397 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
398 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
399 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
401 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
402 checklist.append(OptCheck('ACPI_APEI_EINJ', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
403 checklist.append(OptCheck('PROFILING', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
404 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
405 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
407 checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
408 # checklist.append(OptCheck('IKCONFIG', 'is not set', 'clipos', 'cut_attack_surface')) # no, this info is needed for this check :)
409 checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
410 checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
411 checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
412 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
413 checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
414 checklist.append(AND(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'), \
415 VerCheck((5, 1)))) # LDISC_AUTOLOAD can be disabled since v5.1
417 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
418 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
419 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
420 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
421 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface'))
422 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
423 checklist.append(OptCheck('VIDEO_VIVID', 'is not set', 'my', 'cut_attack_surface'))
424 if debug_mode or arch == 'X86_32':
425 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
427 if debug_mode or arch == 'ARM64':
428 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_hardening'))
429 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
430 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_hardening'))
431 if debug_mode or arch == 'X86_32' or arch == 'ARM':
432 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_hardening'))
434 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
437 def print_checklist(checklist, with_results):
441 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
445 print(json.dumps(opts))
449 print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
452 print('| {}'.format('check result'), end='')
456 print('=' * sep_line_len)
458 for opt in checklist:
459 print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
461 print('| {}'.format(opt.result), end='')
466 def perform_checks(checklist, parsed_options):
467 for opt in checklist:
468 if hasattr(opt, 'opts'):
469 # prepare ComplexOptCheck
471 if hasattr(o, 'name'):
472 o.state = parsed_options.get(o.name, None)
474 # prepare simple OptCheck
475 if not hasattr(opt, 'name'):
476 sys.exit('[!] ERROR: bad OptCheck {}'.format(vars(opt)))
477 opt.state = parsed_options.get(opt.name, None)
481 def check_config_file(checklist, fname):
482 with open(fname, 'r') as f:
483 parsed_options = OrderedDict()
484 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
485 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
488 print('[+] Checking "{}" against hardening preferences...'.format(fname))
489 for line in f.readlines():
494 if opt_is_on.match(line):
495 option, value = line[7:].split('=', 1)
496 elif opt_is_off.match(line):
497 option, value = line[9:].split(' ', 1)
498 if value != 'is not set':
499 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
501 if option in parsed_options:
502 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
504 if option is not None:
505 parsed_options[option] = value
507 perform_checks(checklist, parsed_options)
510 known_options = [opt.name for opt in checklist]
511 for option, value in parsed_options.items():
512 if option not in known_options:
513 print("DEBUG: dunno about option {} ({})".format(option, value))
515 print_checklist(checklist, True)
518 if __name__ == '__main__':
519 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
520 parser.add_argument('-p', '--print', choices=supported_archs,
521 help='print hardening preferences for selected architecture')
522 parser.add_argument('-c', '--config',
523 help='check the config_file against these preferences')
524 parser.add_argument('--debug', action='store_true',
525 help='enable internal debug mode')
526 parser.add_argument('--json', action='store_true',
527 help='print results in JSON format')
528 args = parser.parse_args()
534 if debug_mode and json_mode:
535 sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
538 arch, msg = detect_arch(args.config)
540 sys.exit('[!] ERROR: {}'.format(msg))
542 print('[+] Detected architecture: {}'.format(arch))
544 kernel_version, msg = detect_version(args.config)
545 if not kernel_version:
546 sys.exit('[!] ERROR: {}'.format(msg))
548 print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
550 construct_checklist(config_checklist, arch)
551 check_config_file(config_checklist, args.config)
552 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
553 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
557 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
562 construct_checklist(config_checklist, arch)
564 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
565 print_checklist(config_checklist, False)