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
40 # kernel.unprivileged_bpf_disabled=1
43 from argparse import ArgumentParser
44 from collections import OrderedDict
48 debug_mode = False # set it to True to print the unknown options from the config
49 json_mode = False # if True, print results in JSON format
51 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
55 def __init__(self, name, expected, decision, reason):
57 self.expected = expected
58 self.decision = decision
64 if self.expected == self.state:
66 elif self.state is None:
67 if self.expected == 'is not set':
68 self.result = 'OK: not found'
70 self.result = 'FAIL: not found'
72 self.result = 'FAIL: "' + self.state + '"'
74 if self.result.startswith('OK'):
75 return True, self.result
77 return False, self.result
80 return '{} = {}'.format(self.name, self.state)
83 class ComplexOptCheck:
84 def __init__(self, *opts):
90 return self.opts[0].name
94 return self.opts[0].expected
98 return self.opts[0].state
102 return self.opts[0].decision
106 return self.opts[0].reason
109 class OR(ComplexOptCheck):
110 # self.opts[0] is the option which this OR-check is about.
112 # OR(<X_is_hardened>, <X_is_disabled>)
113 # OR(<X_is_hardened>, <X_is_hardened_old>)
117 sys.exit('[!] ERROR: invalid OR check')
119 for i, opt in enumerate(self.opts):
120 ret, msg = opt.check()
123 self.result = opt.result
125 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
126 return True, self.result
127 self.result = self.opts[0].result
128 return False, self.result
131 class AND(ComplexOptCheck):
132 # self.opts[0] is the option which this AND-check is about.
133 # Use case: AND(<suboption>, <main_option>)
134 # Suboption is not checked if checking of the main_option is failed.
137 for i, opt in reversed(list(enumerate(self.opts))):
138 ret, msg = opt.check()
140 self.result = opt.result
141 return ret, self.result
143 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
144 return False, self.result
146 sys.exit('[!] ERROR: invalid AND check')
149 def detect_arch(fname):
150 with open(fname, 'r') as f:
151 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
155 print('[+] Trying to detect architecture in "{}"...'.format(fname))
156 for line in f.readlines():
157 if arch_pattern.match(line):
158 option, value = line[7:].split('=', 1)
159 if option in supported_archs:
163 return None, 'more than one supported architecture is detected'
165 return None, 'failed to detect architecture'
170 def construct_checklist(checklist, arch):
171 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
172 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
174 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
175 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
176 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
177 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
178 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
179 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
180 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
181 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
182 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
183 if debug_mode or arch == 'X86_64':
184 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
185 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
186 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
187 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
188 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
189 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
190 checklist.append(OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection'))
191 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
192 if debug_mode or arch == 'ARM64':
193 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
194 checklist.append(OptCheck('HARDEN_EL2_VECTORS', 'y', 'defconfig', 'self_protection'))
195 checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
196 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
197 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
198 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
199 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
200 if debug_mode or arch == 'ARM':
201 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'self_protection'))
202 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
203 if debug_mode or arch == 'ARM64' or arch == 'ARM':
204 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'))
205 checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))
207 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
208 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
209 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
210 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
211 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
212 checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
213 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
214 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'kspp', 'self_protection'))
215 randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
216 checklist.append(randstruct_is_set)
217 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
218 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
219 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
220 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
221 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
222 page_poisoning_is_set = OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection')
223 checklist.append(page_poisoning_is_set)
224 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
225 checklist.append(hardened_usercopy_is_set)
226 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
227 hardened_usercopy_is_set))
228 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
230 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
232 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
234 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
235 modules_not_set)) # refers to LOCK_DOWN_KERNEL
236 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
237 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
238 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'kspp', 'self_protection'))
239 if debug_mode or arch == 'X86_32':
240 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
241 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
242 if debug_mode or arch == 'ARM64':
243 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
244 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'kspp', 'self_protection'))
245 if debug_mode or arch == 'ARM64' or arch == 'ARM':
246 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
247 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
249 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
250 checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
251 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
252 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
253 checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
255 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
256 stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'clipos', 'self_protection')
257 checklist.append(stackleak_is_set)
258 checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
260 checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
262 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
263 checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
264 checklist.append(OptCheck('MICROCODE', 'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
265 iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
266 checklist.append(iommu_support_is_set)
267 checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'clipos', 'self_protection'), \
268 iommu_support_is_set))
269 checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
270 iommu_support_is_set))
271 checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
272 iommu_support_is_set))
274 checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'my', 'self_protection'), \
275 OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
276 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
277 checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON', 'y', 'my', 'self_protection'))
278 checklist.append(OptCheck('INIT_ON_FREE_DEFAULT_ON', 'y', 'my', 'self_protection'))
279 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
280 checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY', 'is not set', 'my', 'self_protection'), \
281 page_poisoning_is_set))
282 checklist.append(AND(OptCheck('PAGE_POISONING_ZERO', 'is not set', 'my', 'self_protection'), \
283 page_poisoning_is_set))
284 if debug_mode or arch == 'X86_64':
285 checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'my', 'self_protection'), \
286 iommu_support_is_set))
287 checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
288 iommu_support_is_set))
289 if debug_mode or arch == 'X86_32':
290 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
291 if debug_mode or arch == 'ARM':
292 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'my', 'self_protection'))
294 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
295 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
296 if debug_mode or arch == 'ARM':
297 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
298 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
299 checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'security_policy')) # needs userspace support
300 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM', 'y', 'my', 'security_policy'))
301 checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM_EARLY', 'y', 'my', 'security_policy'))
302 checklist.append(OptCheck('LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y', 'my', 'security_policy'))
304 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
305 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
306 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
307 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
308 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
310 checklist.append(modules_not_set)
311 checklist.append(devmem_not_set)
312 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
313 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
314 if debug_mode or arch == 'ARM':
315 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
316 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
317 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
318 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
319 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface'))
320 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
321 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
322 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
323 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
324 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
325 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
326 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
327 if debug_mode or arch == 'X86_64':
328 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
329 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
330 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
331 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
332 if debug_mode or arch == 'ARM':
333 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
335 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
336 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
337 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
338 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
339 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
340 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
341 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
342 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface'))
343 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
344 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
345 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
346 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
347 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
348 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
349 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
350 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
351 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
352 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
354 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
355 checklist.append(OptCheck('ACPI_APEI_EINJ', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
356 checklist.append(OptCheck('PROFILING', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
357 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
358 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
360 checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
361 checklist.append(OptCheck('IKCONFIG', 'is not set', 'clipos', 'cut_attack_surface'))
362 checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
363 checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
364 checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
365 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
366 checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
367 checklist.append(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'))
369 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
370 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
371 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
372 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
373 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface'))
374 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
375 if debug_mode or arch == 'X86_32':
376 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
378 if debug_mode or arch == 'ARM64':
379 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_protection'))
380 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
381 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_protection'))
382 if debug_mode or arch == 'X86_32' or arch == 'ARM':
383 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_protection'))
385 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
388 def print_checklist(checklist, with_results):
392 opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
396 print(json.dumps(opts))
400 print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
403 print('||{:^28}'.format('check result'), end='')
407 print('=' * sep_line_len)
409 for opt in checklist:
410 print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
412 print('||{:^28}'.format(opt.result), end='')
417 def get_option_state(options, name):
418 return options.get(name, None)
421 def perform_checks(checklist, parsed_options):
422 for opt in checklist:
423 if hasattr(opt, 'opts'):
425 o.state = get_option_state(parsed_options, o.name)
427 opt.state = get_option_state(parsed_options, opt.name)
431 def check_config_file(checklist, fname):
432 with open(fname, 'r') as f:
433 parsed_options = OrderedDict()
434 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
435 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
438 print('[+] Checking "{}" against hardening preferences...'.format(fname))
439 for line in f.readlines():
444 if opt_is_on.match(line):
445 option, value = line[7:].split('=', 1)
446 elif opt_is_off.match(line):
447 option, value = line[9:].split(' ', 1)
448 if value != 'is not set':
449 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
451 if option in parsed_options:
452 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
454 if option is not None:
455 parsed_options[option] = value
457 perform_checks(checklist, parsed_options)
460 known_options = [opt.name for opt in checklist]
461 for option, value in parsed_options.items():
462 if option not in known_options:
463 print("DEBUG: dunno about option {} ({})".format(option, value))
465 print_checklist(checklist, True)
468 if __name__ == '__main__':
469 config_checklist = []
471 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
472 parser.add_argument('-p', '--print', choices=supported_archs,
473 help='print hardening preferences for selected architecture')
474 parser.add_argument('-c', '--config',
475 help='check the config_file against these preferences')
476 parser.add_argument('--debug', action='store_true',
477 help='enable internal debug mode')
478 parser.add_argument('--json', action='store_true',
479 help='print results in JSON format')
480 args = parser.parse_args()
486 if debug_mode and json_mode:
487 sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
490 arch, msg = detect_arch(args.config)
492 sys.exit('[!] ERROR: {}'.format(msg))
494 print('[+] Detected architecture: {}'.format(arch))
496 construct_checklist(config_checklist, arch)
497 check_config_file(config_checklist, args.config)
498 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
499 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
503 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
508 construct_checklist(config_checklist, arch)
510 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
511 print_checklist(config_checklist, False)