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:
18 # kernel.kptr_restrict=1
21 # Mitigations of CPU vulnerabilities:
23 # mitigations=auto,nosmt
27 # spec_store_bypass_disable=on
34 # N.B. Hardening sysctls:
35 # net.core.bpf_jit_harden=2
37 # vm.unprivileged_userfaultfd=0
38 # kernel.perf_event_paranoid=3
39 # kernel.yama.ptrace_scope=1 (or even 3?)
40 # kernel.unprivileged_bpf_disabled=1
42 # fs.protected_symlinks = 1
43 # fs.protected_hardlinks = 1
44 # fs.protected_fifos = 2
45 # fs.protected_regular = 2
48 from argparse import ArgumentParser
49 from collections import OrderedDict
53 debug_mode = False # set it to True to print the unknown options from the config
54 json_mode = False # if True, print results in JSON format
56 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
60 def __init__(self, name, expected, decision, reason):
62 self.expected = expected
63 self.decision = decision
69 if self.expected == self.state:
71 elif self.state is None:
72 if self.expected == 'is not set':
73 self.result = 'OK: not found'
75 self.result = 'FAIL: not found'
77 self.result = 'FAIL: "' + self.state + '"'
79 if self.result.startswith('OK'):
80 return True, self.result
82 return False, self.result
85 return '{} = {}'.format(self.name, self.state)
88 class ComplexOptCheck:
89 def __init__(self, *opts):
95 return self.opts[0].name
99 return self.opts[0].expected
103 return self.opts[0].state
107 return self.opts[0].decision
111 return self.opts[0].reason
114 class OR(ComplexOptCheck):
115 # self.opts[0] is the option which this OR-check is about.
117 # OR(<X_is_hardened>, <X_is_disabled>)
118 # OR(<X_is_hardened>, <X_is_hardened_old>)
122 sys.exit('[!] ERROR: invalid OR check')
124 for i, opt in enumerate(self.opts):
125 ret, msg = opt.check()
128 self.result = opt.result
130 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
131 return True, self.result
132 self.result = self.opts[0].result
133 return False, self.result
136 class AND(ComplexOptCheck):
137 # self.opts[0] is the option which this AND-check is about.
138 # Use case: AND(<suboption>, <main_option>)
139 # Suboption is not checked if checking of the main_option is failed.
142 for i, opt in reversed(list(enumerate(self.opts))):
143 ret, msg = opt.check()
145 self.result = opt.result
146 return ret, self.result
148 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
149 return False, self.result
151 sys.exit('[!] ERROR: invalid AND check')
154 def detect_arch(fname):
155 with open(fname, 'r') as f:
156 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
160 print('[+] Trying to detect architecture in "{}"...'.format(fname))
161 for line in f.readlines():
162 if arch_pattern.match(line):
163 option, value = line[7:].split('=', 1)
164 if option in supported_archs:
168 return None, 'more than one supported architecture is detected'
170 return None, 'failed to detect architecture'
175 def construct_checklist(checklist, arch):
176 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
177 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
179 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
180 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
181 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
182 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
183 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
184 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
185 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
186 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
187 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
188 if debug_mode or arch == 'X86_64':
189 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
190 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
191 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
192 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
193 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
194 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
195 checklist.append(OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection'))
196 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
197 if debug_mode or arch == 'ARM64':
198 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
199 checklist.append(OptCheck('HARDEN_EL2_VECTORS', 'y', 'defconfig', 'self_protection'))
200 checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
201 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
202 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
203 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
204 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
205 if debug_mode or arch == 'ARM':
206 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'self_protection'))
207 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
208 if debug_mode or arch == 'ARM64' or arch == 'ARM':
209 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'))
210 checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))
212 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
213 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
214 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
215 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
216 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
217 checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
218 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
219 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'kspp', 'self_protection'))
220 randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
221 checklist.append(randstruct_is_set)
222 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
223 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
224 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
225 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
226 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
227 page_poisoning_is_set = OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection')
228 checklist.append(page_poisoning_is_set)
229 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
230 checklist.append(hardened_usercopy_is_set)
231 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
232 hardened_usercopy_is_set))
233 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
235 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
237 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
239 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
240 modules_not_set)) # refers to LOCK_DOWN_KERNEL
241 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
242 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
243 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'kspp', 'self_protection'))
244 if debug_mode or arch == 'X86_32':
245 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
246 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
247 if debug_mode or arch == 'ARM64':
248 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
249 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'kspp', 'self_protection'))
250 if debug_mode or arch == 'ARM64' or arch == 'ARM':
251 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
252 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
254 checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'clipos', 'self_protection'), \
255 OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
256 checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON', 'y', 'clipos', 'self_protection'))
257 checklist.append(OptCheck('INIT_ON_FREE_DEFAULT_ON', 'y', 'clipos', 'self_protection'))
258 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
259 checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
260 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
261 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
262 checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
264 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
265 stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'clipos', 'self_protection')
266 checklist.append(stackleak_is_set)
267 checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
269 checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
271 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
272 checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
273 checklist.append(OptCheck('MICROCODE', 'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
274 iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
275 checklist.append(iommu_support_is_set)
276 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'clipos', 'self_protection'), \
277 iommu_support_is_set))
278 checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
279 iommu_support_is_set))
280 checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
281 iommu_support_is_set))
283 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
284 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
285 checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY', 'is not set', 'my', 'self_protection'), \
286 page_poisoning_is_set))
287 checklist.append(AND(OptCheck('PAGE_POISONING_ZERO', 'is not set', 'my', 'self_protection'), \
288 page_poisoning_is_set))
289 if debug_mode or arch == 'X86_64':
290 checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'my', 'self_protection'), \
291 iommu_support_is_set))
292 checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
293 iommu_support_is_set))
294 if debug_mode or arch == 'X86_32':
295 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
296 if debug_mode or arch == 'ARM':
297 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'my', 'self_protection'))
299 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
300 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
301 if debug_mode or arch == 'ARM':
302 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
303 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
304 checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'security_policy')) # needs userspace support
305 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM', 'y', 'my', 'security_policy'))
306 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM_EARLY', 'y', 'my', 'security_policy'))
307 checklist.append(OptCheck('LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y', 'my', 'security_policy'))
309 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
310 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
311 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
312 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
313 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
315 checklist.append(modules_not_set)
316 checklist.append(devmem_not_set)
317 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
318 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
319 if debug_mode or arch == 'ARM':
320 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
321 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
322 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
323 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
324 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface'))
325 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
326 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
327 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
328 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
329 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
330 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
331 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
332 if debug_mode or arch == 'X86_64':
333 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
334 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
335 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
336 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
337 if debug_mode or arch == 'ARM':
338 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
340 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
341 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
342 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
343 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
344 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
345 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
346 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
347 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface'))
348 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
349 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
350 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
351 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
352 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
353 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
354 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
355 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
356 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
357 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
359 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
360 checklist.append(OptCheck('ACPI_APEI_EINJ', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
361 checklist.append(OptCheck('PROFILING', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
362 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
363 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
365 checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
366 # checklist.append(OptCheck('IKCONFIG', 'is not set', 'clipos', 'cut_attack_surface')) # no, this info is needed for this check :)
367 checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
368 checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
369 checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
370 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
371 checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
372 checklist.append(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'))
374 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
375 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
376 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
377 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
378 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface'))
379 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
380 if debug_mode or arch == 'X86_32':
381 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
383 if debug_mode or arch == 'ARM64':
384 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_protection'))
385 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
386 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_protection'))
387 if debug_mode or arch == 'X86_32' or arch == 'ARM':
388 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_protection'))
390 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
393 def print_checklist(checklist, with_results):
397 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
401 print(json.dumps(opts))
405 print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
408 print('||{:^28}'.format('check result'), end='')
412 print('=' * sep_line_len)
414 for opt in checklist:
415 print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
417 print('||{:^28}'.format(opt.result), end='')
422 def get_option_state(options, name):
423 return options.get(name, None)
426 def perform_checks(checklist, parsed_options):
427 for opt in checklist:
428 if hasattr(opt, 'opts'):
430 o.state = get_option_state(parsed_options, o.name)
432 opt.state = get_option_state(parsed_options, opt.name)
436 def check_config_file(checklist, fname):
437 with open(fname, 'r') as f:
438 parsed_options = OrderedDict()
439 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
440 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
443 print('[+] Checking "{}" against hardening preferences...'.format(fname))
444 for line in f.readlines():
449 if opt_is_on.match(line):
450 option, value = line[7:].split('=', 1)
451 elif opt_is_off.match(line):
452 option, value = line[9:].split(' ', 1)
453 if value != 'is not set':
454 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
456 if option in parsed_options:
457 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
459 if option is not None:
460 parsed_options[option] = value
462 perform_checks(checklist, parsed_options)
465 known_options = [opt.name for opt in checklist]
466 for option, value in parsed_options.items():
467 if option not in known_options:
468 print("DEBUG: dunno about option {} ({})".format(option, value))
470 print_checklist(checklist, True)
473 if __name__ == '__main__':
474 config_checklist = []
476 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
477 parser.add_argument('-p', '--print', choices=supported_archs,
478 help='print hardening preferences for selected architecture')
479 parser.add_argument('-c', '--config',
480 help='check the config_file against these preferences')
481 parser.add_argument('--debug', action='store_true',
482 help='enable internal debug mode')
483 parser.add_argument('--json', action='store_true',
484 help='print results in JSON format')
485 args = parser.parse_args()
491 if debug_mode and json_mode:
492 sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
495 arch, msg = detect_arch(args.config)
497 sys.exit('[!] ERROR: {}'.format(msg))
499 print('[+] Detected architecture: {}'.format(arch))
501 construct_checklist(config_checklist, arch)
502 check_config_file(config_checklist, args.config)
503 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
504 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
508 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
513 construct_checklist(config_checklist, arch)
515 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
516 print_checklist(config_checklist, False)