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
23 # spec_store_bypass_disable=on
27 # N.B. Hardening sysctl's:
28 # net.core.bpf_jit_harden
31 from argparse import ArgumentParser
32 from collections import OrderedDict
35 debug_mode = False # set it to True to print the unknown options from the config
37 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
43 def __init__(self, name, expected, decision, reason):
45 self.expected = expected
46 self.decision = decision
52 if self.expected == self.state:
54 elif self.state is None:
55 if self.expected == 'is not set':
56 self.result = 'OK: not found'
58 self.result = 'FAIL: not found'
60 self.result = 'FAIL: "' + self.state + '"'
62 if self.result.startswith('OK'):
63 return True, self.result
65 return False, self.result
68 return '{} = {}'.format(self.name, self.state)
71 class ComplexOptCheck:
72 def __init__(self, *opts):
78 return self.opts[0].name
82 return self.opts[0].expected
86 return self.opts[0].state
90 return self.opts[0].decision
94 return self.opts[0].reason
97 class OR(ComplexOptCheck):
98 # self.opts[0] is the option which this OR-check is about.
100 # OR(<X_is_hardened>, <X_is_disabled>)
101 # OR(<X_is_hardened>, <X_is_hardened_old>)
105 sys.exit('[!] ERROR: invalid OR check')
107 for i, opt in enumerate(self.opts):
108 ret, msg = opt.check()
111 self.result = opt.result
113 self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
114 return True, self.result
115 self.result = self.opts[0].result
116 return False, self.result
119 class AND(ComplexOptCheck):
120 # self.opts[0] is the option which this AND-check is about.
121 # Use case: AND(<suboption>, <main_option>)
122 # Suboption is not checked if checking of the main_option is failed.
125 for i, opt in reversed(list(enumerate(self.opts))):
126 ret, msg = opt.check()
128 self.result = opt.result
129 return ret, self.result
131 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
132 return False, self.result
134 sys.exit('[!] ERROR: invalid AND check')
137 def detect_arch(fname):
138 with open(fname, 'r') as f:
139 arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
142 print('[+] Trying to detect architecture in "{}"...'.format(fname))
143 for line in f.readlines():
144 if arch_pattern.match(line):
145 option, value = line[7:].split('=', 1)
146 if option in supported_archs:
150 return None, 'more than one supported architecture is detected'
152 return None, 'failed to detect architecture'
157 def construct_checklist(arch):
158 modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
159 devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
161 checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
162 checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
163 OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
164 checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
165 OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
166 checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
167 checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
168 OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
169 modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
170 if debug_mode or arch == 'X86_64':
171 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
172 checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
173 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
174 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
175 checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
176 checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
177 checklist.append(OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection'))
178 checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
179 if debug_mode or arch == 'ARM64':
180 checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
181 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
182 checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
183 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
184 checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
185 if debug_mode or arch == 'ARM':
186 checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'self_protection'))
187 checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
188 if debug_mode or arch == 'ARM64' or arch == 'ARM':
189 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'))
191 checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
192 checklist.append(OptCheck('DEBUG_WX', 'y', 'kspp', 'self_protection'))
193 checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
194 checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
195 checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
196 checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
197 checklist.append(OptCheck('GCC_PLUGINS', 'y', 'kspp', 'self_protection'))
198 checklist.append(OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection'))
199 checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK', 'y', 'kspp', 'self_protection'))
200 checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection'))
201 checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
202 checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
203 checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
204 checklist.append(OptCheck('DEBUG_CREDENTIALS', 'y', 'kspp', 'self_protection'))
205 checklist.append(OptCheck('DEBUG_NOTIFIERS', 'y', 'kspp', 'self_protection'))
206 page_poisoning_is_set = OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection')
207 checklist.append(page_poisoning_is_set)
208 hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY', 'y', 'kspp', 'self_protection')
209 checklist.append(hardened_usercopy_is_set)
210 checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK', 'is not set', 'kspp', 'self_protection'), \
211 hardened_usercopy_is_set))
212 checklist.append(OR(OptCheck('MODULE_SIG', 'y', 'kspp', 'self_protection'), \
214 checklist.append(OR(OptCheck('MODULE_SIG_ALL', 'y', 'kspp', 'self_protection'), \
216 checklist.append(OR(OptCheck('MODULE_SIG_SHA512', 'y', 'kspp', 'self_protection'), \
218 checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
219 modules_not_set)) # refers to LOCK_DOWN_KERNEL
220 if debug_mode or arch == 'X86_64' or arch == 'X86_32':
221 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
222 checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'kspp', 'self_protection'))
223 if debug_mode or arch == 'X86_32':
224 checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
225 checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
226 if debug_mode or arch == 'ARM64':
227 checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
228 checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'kspp', 'self_protection'))
229 if debug_mode or arch == 'ARM64' or arch == 'ARM':
230 checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
231 checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
233 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
234 checklist.append(OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'my', 'self_protection'))
235 checklist.append(OptCheck('LOCK_DOWN_KERNEL', 'y', 'my', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
236 checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
237 checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'my', 'self_protection'))
238 checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
239 checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'self_protection')) # needs userspace support
240 checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
241 checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'my', 'self_protection')) # slab_nomerge
242 checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY', 'is not set', 'my', 'self_protection'), \
243 page_poisoning_is_set))
244 checklist.append(AND(OptCheck('PAGE_POISONING_ZERO', 'is not set', 'my', 'self_protection'), \
245 page_poisoning_is_set))
246 if debug_mode or arch == 'X86_32':
247 checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
248 if debug_mode or arch == 'ARM':
249 checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'my', 'self_protection'))
251 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
252 checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy'))
253 if debug_mode or arch == 'ARM':
254 checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy'))
255 checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
256 checklist.append(OptCheck('SECURITY_SELINUX_DISABLE', 'is not set', 'kspp', 'security_policy'))
258 checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
259 checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
260 if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
261 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
262 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
264 checklist.append(modules_not_set)
265 checklist.append(devmem_not_set)
266 checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
267 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
268 if debug_mode or arch == 'ARM':
269 checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
270 devmem_not_set)) # refers to LOCK_DOWN_KERNEL
271 checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
272 checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
273 checklist.append(OptCheck('DEVKMEM', 'is not set', 'kspp', 'cut_attack_surface'))
274 checklist.append(OptCheck('COMPAT_VDSO', 'is not set', 'kspp', 'cut_attack_surface'))
275 checklist.append(OptCheck('BINFMT_MISC', 'is not set', 'kspp', 'cut_attack_surface'))
276 checklist.append(OptCheck('INET_DIAG', 'is not set', 'kspp', 'cut_attack_surface'))
277 checklist.append(OptCheck('KEXEC', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
278 checklist.append(OptCheck('PROC_KCORE', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
279 checklist.append(OptCheck('LEGACY_PTYS', 'is not set', 'kspp', 'cut_attack_surface'))
280 checklist.append(OptCheck('HIBERNATION', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
281 if debug_mode or arch == 'X86_64':
282 checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
283 checklist.append(OptCheck('IA32_EMULATION', 'is not set', 'kspp', 'cut_attack_surface'))
284 checklist.append(OptCheck('X86_X32', 'is not set', 'kspp', 'cut_attack_surface'))
285 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'kspp', 'cut_attack_surface'))
286 if debug_mode or arch == 'ARM':
287 checklist.append(OptCheck('OABI_COMPAT', 'is not set', 'kspp', 'cut_attack_surface'))
289 checklist.append(OptCheck('X86_PTDUMP', 'is not set', 'grsecurity', 'cut_attack_surface'))
290 checklist.append(OptCheck('ZSMALLOC_STAT', 'is not set', 'grsecurity', 'cut_attack_surface'))
291 checklist.append(OptCheck('PAGE_OWNER', 'is not set', 'grsecurity', 'cut_attack_surface'))
292 checklist.append(OptCheck('DEBUG_KMEMLEAK', 'is not set', 'grsecurity', 'cut_attack_surface'))
293 checklist.append(OptCheck('BINFMT_AOUT', 'is not set', 'grsecurity', 'cut_attack_surface'))
294 checklist.append(OptCheck('KPROBES', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
295 checklist.append(OptCheck('UPROBES', 'is not set', 'grsecurity', 'cut_attack_surface'))
296 checklist.append(OptCheck('GENERIC_TRACER', 'is not set', 'grsecurity', 'cut_attack_surface'))
297 checklist.append(OptCheck('PROC_VMCORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
298 checklist.append(OptCheck('PROC_PAGE_MONITOR', 'is not set', 'grsecurity', 'cut_attack_surface'))
299 checklist.append(OptCheck('USELIB', 'is not set', 'grsecurity', 'cut_attack_surface'))
300 checklist.append(OptCheck('CHECKPOINT_RESTORE', 'is not set', 'grsecurity', 'cut_attack_surface'))
301 checklist.append(OptCheck('USERFAULTFD', 'is not set', 'grsecurity', 'cut_attack_surface'))
302 checklist.append(OptCheck('HWPOISON_INJECT', 'is not set', 'grsecurity', 'cut_attack_surface'))
303 checklist.append(OptCheck('MEM_SOFT_DIRTY', 'is not set', 'grsecurity', 'cut_attack_surface'))
304 checklist.append(OptCheck('DEVPORT', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
305 checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
306 checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
308 checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
309 checklist.append(OptCheck('ACPI_APEI_EINJ', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
310 checklist.append(OptCheck('PROFILING', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
311 checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
312 checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
314 checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
315 checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
316 checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
317 checklist.append(OptCheck('USER_NS', 'is not set', 'my', 'cut_attack_surface')) # user.max_user_namespaces=0
318 checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
319 checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
320 checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface'))
321 checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
322 if debug_mode or arch == 'X86_32':
323 checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
325 if debug_mode or arch == 'ARM64':
326 checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_protection'))
327 if debug_mode or arch == 'X86_64' or arch == 'ARM64':
328 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'my', 'userspace_protection'))
329 if debug_mode or arch == 'X86_32' or arch == 'ARM':
330 checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_protection'))
332 # checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
335 def print_checklist(arch):
336 print('[+] Printing kernel hardening preferences for {}...'.format(arch))
337 print(' {:<39}|{:^13}|{:^10}|{:^20}'.format(
338 'option name', 'desired val', 'decision', 'reason'))
339 print(' ' + '=' * 86)
340 for opt in checklist:
341 print(' CONFIG_{:<32}|{:^13}|{:^10}|{:^20}'.format(
342 opt.name, opt.expected, opt.decision, opt.reason))
346 def print_check_results():
347 print(' {:<39}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
348 'option name', 'desired val', 'decision', 'reason', 'check result'))
349 print(' ' + '=' * 115)
350 for opt in checklist:
351 print(' CONFIG_{:<32}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
352 opt.name, opt.expected, opt.decision, opt.reason, opt.result))
356 def get_option_state(options, name):
357 return options.get(name, None)
360 def perform_checks(parsed_options):
361 for opt in checklist:
362 if hasattr(opt, 'opts'):
364 o.state = get_option_state(parsed_options, o.name)
366 opt.state = get_option_state(parsed_options, opt.name)
370 def check_config_file(fname):
371 with open(fname, 'r') as f:
372 parsed_options = OrderedDict()
373 opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
374 opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
376 print('[+] Checking "{}" against hardening preferences...'.format(fname))
377 for line in f.readlines():
382 if opt_is_on.match(line):
383 option, value = line[7:].split('=', 1)
384 elif opt_is_off.match(line):
385 option, value = line[9:].split(' ', 1)
386 if value != 'is not set':
387 sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
389 if option in parsed_options:
390 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
392 if option is not None:
393 parsed_options[option] = value
395 perform_checks(parsed_options)
398 known_options = [opt.name for opt in checklist]
399 for option, value in parsed_options.items():
400 if option not in known_options:
401 print("DEBUG: dunno about option {} ({})".format(option, value))
403 print_check_results()
406 if __name__ == '__main__':
407 parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
408 parser.add_argument('-p', '--print', choices=supported_archs,
409 help='print hardening preferences for selected architecture')
410 parser.add_argument('-c', '--config',
411 help='check the config_file against these preferences')
412 parser.add_argument('--debug', action='store_true',
413 help='enable internal debug mode')
414 args = parser.parse_args()
420 arch, msg = detect_arch(args.config)
422 sys.exit('[!] ERROR: {}'.format(msg))
424 print('[+] Detected architecture: {}'.format(arch))
426 construct_checklist(arch)
427 check_config_file(args.config)
428 error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
429 ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
432 print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
437 construct_checklist(arch)
438 print_checklist(arch)