#!/usr/bin/python3
#
-# This tool helps me to check the Linux kernel Kconfig option list
-# against my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
+# This tool helps me to check Linux kernel options against
+# my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
# Let the computers do their job!
#
# Author: Alexander Popov <alex.popov@linux.com>
# slab_nomerge
# page_alloc.shuffle=1
# iommu=force (does it help against DMA attacks?)
+# iommu.passthrough=0
+# iommu.strict=1
# slub_debug=FZ (slow)
# init_on_alloc=1 (since v5.3)
# init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
# loadpin.enforce=1
# debugfs=no-mount (or off if possible)
+# randomize_kstack_offset=1
#
# Mitigations of CPU vulnerabilities:
# Аrch-independent:
# pti=on
# spec_store_bypass_disable=on
# l1tf=full,force
+# l1d_flush=on (a part of the l1tf option)
# mds=full,nosmt
# tsx=off
# ARM64:
# kpti=on
# ssbd=force-on
#
+# Should NOT be set:
+# nokaslr
+# arm64.nobti
+# arm64.nopauth
+#
+# Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
+# kasan=on
+# kasan.stacktrace=off
+# kasan.fault=panic
+#
# N.B. Hardening sysctls:
# kernel.kptr_restrict=2 (or 1?)
# kernel.dmesg_restrict=1 (also see the kconfig option)
# net.core.bpf_jit_harden=2
#
# vm.unprivileged_userfaultfd=0
+# (at first, it disabled unprivileged userfaultfd,
+# and since v5.11 it enables unprivileged userfaultfd for user-mode only)
#
# dev.tty.ldisc_autoload=0
# fs.protected_symlinks=1
import json
from .__about__ import __version__
+TYPES_OF_CHECKS = ('kconfig', 'version')
class OptCheck:
- def __init__(self, reason, decision, name, expected):
+ # Constructor without the 'expected' parameter is for option presence checks (any value is OK)
+ def __init__(self, reason, decision, name, expected=None):
+ if not reason or not decision or not name:
+ sys.exit('[!] ERROR: invalid {} check for "{}"'.format(self.__class__.__name__, name))
self.name = name
self.expected = expected
self.decision = decision
self.result = None
def check(self):
+ # handle the option presence check
+ if self.expected is None:
+ if self.state is None:
+ self.result = 'FAIL: not present'
+ else:
+ self.result = 'OK: is present'
+ return
+
+ # handle the option value check
if self.expected == self.state:
self.result = 'OK'
elif self.state is None:
else:
self.result = 'FAIL: "' + self.state + '"'
- if self.result.startswith('OK'):
- return True
- return False
-
def table_print(self, _mode, with_results):
- print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(self.name, self.expected, self.decision, self.reason), end='')
+ if self.expected is None:
+ expected = ''
+ else:
+ expected = self.expected
+ print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, expected, self.decision, self.reason), end='')
if with_results:
- print('| {}'.format(self.result), end='')
+ print('| {}'.format(self.result), end='')
-class VerCheck:
+class KconfigCheck(OptCheck):
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.name = 'CONFIG_' + self.name
+
+ @property
+ def type(self):
+ return 'kconfig'
+
+ def json_dump(self, with_results):
+ dump = [self.name, self.type, self.expected, self.decision, self.reason]
+ if with_results:
+ dump.append(self.result)
+ return dump
+
+
+class VersionCheck:
def __init__(self, ver_expected):
self.ver_expected = ver_expected
self.ver = ()
self.result = None
+ @property
+ def type(self):
+ return 'version'
+
def check(self):
if self.ver[0] > self.ver_expected[0]:
self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
- return True
+ return
if self.ver[0] < self.ver_expected[0]:
self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
- return False
+ return
if self.ver[1] >= self.ver_expected[1]:
self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
- return True
+ return
self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
- return False
def table_print(self, _mode, with_results):
ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
print('{:<91}'.format(ver_req), end='')
if with_results:
- print('| {}'.format(self.result), end='')
-
-
-class PresenceCheck:
- def __init__(self, name):
- self.name = name
- self.state = None
- self.result = None
-
- def check(self):
- if self.state is None:
- self.result = 'FAIL: not present'
- return False
- self.result = 'OK: is present'
- return True
-
- def table_print(self, _mode, with_results):
- print('CONFIG_{:<84}'.format(self.name + ' is present'), end='')
- if with_results:
- print('| {}'.format(self.result), end='')
+ print('| {}'.format(self.result), end='')
class ComplexOptCheck:
self.opts = opts
if not self.opts:
sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
- if not isinstance(opts[0], OptCheck):
+ if len(self.opts) == 1:
+ sys.exit('[!] ERROR: useless {} check'.format(self.__class__.__name__))
+ if not isinstance(opts[0], KconfigCheck):
sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
self.result = None
def name(self):
return self.opts[0].name
+ @property
+ def type(self):
+ return 'complex'
+
@property
def expected(self):
return self.opts[0].expected
if mode == 'verbose':
print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
if with_results:
- print('| {}'.format(self.result), end='')
+ print('| {}'.format(self.result), end='')
for o in self.opts:
print()
o.table_print(mode, with_results)
o = self.opts[0]
o.table_print(mode, False)
if with_results:
- print('| {}'.format(self.result), end='')
+ print('| {}'.format(self.result), end='')
+
+ def json_dump(self, with_results):
+ dump = self.opts[0].json_dump(False)
+ if with_results:
+ dump.append(self.result)
+ return dump
class OR(ComplexOptCheck):
# Use cases:
# OR(<X_is_hardened>, <X_is_disabled>)
# OR(<X_is_hardened>, <old_X_is_hardened>)
-
def check(self):
if not self.opts:
sys.exit('[!] ERROR: invalid OR check')
-
for i, opt in enumerate(self.opts):
- ret = opt.check()
- if ret:
- if opt.result != 'OK' or i == 0:
- # Preserve additional explanation of this OK result.
- # Simple OK is enough only for the main option that
- # this OR-check is about.
- self.result = opt.result
- else:
- # Simple OK is not enough for additional checks.
- self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
- return True
+ opt.check()
+ if opt.result.startswith('OK'):
+ self.result = opt.result
+ # Add more info for additional checks:
+ if i != 0:
+ if opt.result == 'OK':
+ self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
+ elif opt.result == 'OK: not found':
+ self.result = 'OK: {} not found'.format(opt.name)
+ elif opt.result == 'OK: is present':
+ self.result = 'OK: {} is present'.format(opt.name)
+ # VersionCheck provides enough info
+ elif not opt.result.startswith('OK: version'):
+ sys.exit('[!] ERROR: unexpected OK description "{}"'.format(opt.result))
+ return
self.result = self.opts[0].result
- return False
class AND(ComplexOptCheck):
# AND(<suboption>, <main_option>)
# Suboption is not checked if checking of the main_option is failed.
# AND(<X_is_disabled>, <old_X_is_disabled>)
-
def check(self):
for i, opt in reversed(list(enumerate(self.opts))):
- ret = opt.check()
+ opt.check()
if i == 0:
self.result = opt.result
- return ret
- if not ret:
+ return
+ if not opt.result.startswith('OK'):
# This FAIL is caused by additional checks,
# and not by the main option that this AND-check is about.
# Describe the reason of the FAIL.
if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
- self.result = 'FAIL: CONFIG_{} not "{}"'.format(opt.name, opt.expected)
+ self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
elif opt.result == 'FAIL: not present':
- self.result = 'FAIL: CONFIG_{} not present'.format(opt.name)
+ self.result = 'FAIL: {} not present'.format(opt.name)
else:
- # This FAIL message is self-explaining.
+ # VersionCheck provides enough info
self.result = opt.result
- return False
-
+ if not opt.result.startswith('FAIL: version'):
+ sys.exit('[!] ERROR: unexpected FAIL description "{}"'.format(opt.result))
+ return
sys.exit('[!] ERROR: invalid AND check')
return None, 'no kernel version detected'
-def construct_checklist(l, arch):
- modules_not_set = OptCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
- devmem_not_set = OptCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
+def add_kconfig_checks(l, arch):
+ # Calling the KconfigCheck class constructor:
+ # KconfigCheck(reason, decision, name, expected)
+
+ modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
+ devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
+ bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
+ efi_not_set = KconfigCheck('cut_attack_surface', 'my', 'EFI', 'is not set')
# 'self_protection', 'defconfig'
- l += [OptCheck('self_protection', 'defconfig', 'BUG', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
- l += [OR(OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
- OptCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
- l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
- OptCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
- l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
- OptCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
+ l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
+ KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'))]
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
+ KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
+ KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
+ KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
- l += [OR(OptCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
- VerCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
- iommu_support_is_set = OptCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
+ VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
+ l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
+ iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
l += [iommu_support_is_set] # is needed for mitigating DMA attacks
if arch in ('X86_64', 'ARM64', 'X86_32'):
- l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
if arch in ('X86_64', 'ARM64'):
- l += [OptCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
if arch in ('X86_64', 'X86_32'):
- l += [OptCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
- l += [OptCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
- l += [OR(OptCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
- OptCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
+ l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
+ l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
+ KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
if arch in ('ARM64', 'ARM'):
- l += [OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
if arch == 'X86_64':
- l += [OptCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
- l += [AND(OptCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
+ l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
+ l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
iommu_support_is_set)]
- l += [AND(OptCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
+ l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
iommu_support_is_set)]
if arch == 'ARM64':
- l += [OptCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
- l += [OR(OptCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
- AND(OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
- VerCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
- l += [OptCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
- l += [OR(OptCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
- VerCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
+ l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
+ AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
+ VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
+ l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
+ l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
+ VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
+ l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
if arch == 'ARM':
- l += [OptCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
- l += [OptCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
# 'self_protection', 'kspp'
- l += [OptCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
- randstruct_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
+ l += [KconfigCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
+ randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
l += [randstruct_is_set]
- hardened_usercopy_is_set = OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
+ hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
l += [hardened_usercopy_is_set]
- l += [AND(OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
+ l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
hardened_usercopy_is_set)]
- l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
+ l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
+ hardened_usercopy_is_set)]
+ l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
modules_not_set)]
- l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
+ l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
modules_not_set)]
- l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
+ l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
modules_not_set)]
- l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
+ l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
modules_not_set)] # refers to LOCKDOWN
- l += [OR(OptCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
- OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
- l += [OR(OptCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
- OptCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))] # before v5.3
+ l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
+ KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
+ l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
+ KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
+ # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
+ # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
+ # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
+ # the 0xAA poison pattern on allocation.
+ # That brings higher performance penalty.
if arch in ('X86_64', 'ARM64', 'X86_32'):
- stackleak_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
+ stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
l += [stackleak_is_set]
+ l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
if arch in ('X86_64', 'X86_32'):
- l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
+ l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
if arch in ('ARM64', 'ARM'):
- l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
- l += [OptCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
+ l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
+ l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
if arch == 'ARM64':
- l += [OptCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
if arch == 'X86_32':
- l += [OptCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
- l += [OptCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
+ l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
+
+ # 'self_protection', 'maintainer'
+ ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
+ l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
+ if arch in ('X86_64', 'ARM64', 'X86_32'): # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
+ l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
+ ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
+ l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
+ ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
# 'self_protection', 'clipos'
- l += [OptCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
- l += [OptCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
- l += [OptCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y')]
- l += [OptCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
- l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
- l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
- l += [AND(OptCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
+ l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
+ l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
+ l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
+ efi_not_set)]
+ l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
+ l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
+ l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
+ l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
randstruct_is_set)]
if arch in ('X86_64', 'ARM64', 'X86_32'):
- l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
+ l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
stackleak_is_set)]
- l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
+ l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
stackleak_is_set)]
if arch in ('X86_64', 'X86_32'):
- l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
+ l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
iommu_support_is_set)]
if arch == 'X86_64':
- l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
+ l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
iommu_support_is_set)]
if arch == 'X86_32':
- l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
+ l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
iommu_support_is_set)]
# 'self_protection', 'my'
- l += [AND(OptCheck('self_protection', 'my', 'UBSAN_BOUNDS', 'y'),
- OptCheck('self_protection', 'my', 'UBSAN_MISC', 'is not set'),
- OptCheck('self_protection', 'my', 'UBSAN_TRAP', 'y'))]
- l += [OptCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y')] # needs userspace support (systemd)
+ l += [OR(KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y'),
+ efi_not_set)] # needs userspace support (systemd)
if arch == 'X86_64':
- l += [AND(OptCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
+ l += [KconfigCheck('self_protection', 'my', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
+ l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
iommu_support_is_set)]
if arch == 'ARM64':
- l += [OptCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
+ l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
+ l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
+ cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
+ l += [cfi_clang_is_set]
+ l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
+ cfi_clang_is_set)]
# 'security_policy'
if arch in ('X86_64', 'ARM64', 'X86_32'):
- l += [OptCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
+ l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
if arch == 'ARM':
- l += [OptCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
- l += [OptCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
- l += [OR(OptCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
- OptCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
- l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
- l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
- l += [OptCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
- l += [OptCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
- loadpin_is_set = OptCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
+ l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
+ l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
+ l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
+ l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
+ l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
+ l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
+ l += [KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
+ l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
+ loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
l += [loadpin_is_set] # needs userspace support
- l += [AND(OptCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
+ l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
loadpin_is_set)]
# 'cut_attack_surface', 'defconfig'
- l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
- l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
+ l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
+ bpf_syscall_not_set)] # see unprivileged_bpf_disabled
+ l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
+ l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
if arch in ('X86_64', 'ARM64', 'X86_32'):
- l += [OR(OptCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
+ l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
devmem_not_set)] # refers to LOCKDOWN
# 'cut_attack_surface', 'kspp'
- l += [OptCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
l += [modules_not_set]
l += [devmem_not_set]
- l += [OR(OptCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
+ l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
devmem_not_set)] # refers to LOCKDOWN
if arch == 'ARM':
- l += [OR(OptCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
+ l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
devmem_not_set)] # refers to LOCKDOWN
if arch == 'X86_64':
- l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
-
- # 'cut_attack_surface', 'grsecurity'
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'ZSMALLOC_STAT', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'PAGE_OWNER', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_KMEMLEAK', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'BINFMT_AOUT', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'KPROBES', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'UPROBES', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_VMCORE', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_PAGE_MONITOR', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'USELIB', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'CHECKPOINT_RESTORE', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'USERFAULTFD', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'HWPOISON_INJECT', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'MEM_SOFT_DIRTY', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'grsecurity', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
- l += [AND(OptCheck('cut_attack_surface', 'grsecurity', 'X86_PTDUMP', 'is not set'),
- OptCheck('cut_attack_surface', 'my', 'PTDUMP_DEBUGFS', 'is not set'))]
+ l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
+
+ # 'cut_attack_surface', 'grsec'
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
+ l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
+ KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
# 'cut_attack_surface', 'maintainer'
- l += [OptCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
+ l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
+ l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
+ l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
# 'cut_attack_surface', 'grapheneos'
- l += [OptCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
# 'cut_attack_surface', 'clipos'
- l += [OptCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
-# l += [OptCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
- l += [OptCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
- l += [OptCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
- l += [OptCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'clipos', 'IO_URING', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
- l += [AND(OptCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
- PresenceCheck('LDISC_AUTOLOAD'))]
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
+# l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
+ l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
+ KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
if arch in ('X86_64', 'X86_32'):
- l += [OptCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
+ l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
# 'cut_attack_surface', 'lockdown'
- l += [OptCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
+ l += [bpf_syscall_not_set] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
# 'cut_attack_surface', 'my'
- l += [OptCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y')]
- l += [OptCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
- l += [OptCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
- l += [OptCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
- l += [OptCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
-
- # 'userspace_hardening'
+ l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
+ modules_not_set)]
+ l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
+ l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
+ l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
+ l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
+
+ # 'harden_userspace'
if arch in ('X86_64', 'ARM64', 'X86_32'):
- l += [OptCheck('userspace_hardening', 'defconfig', 'INTEGRITY', 'y')]
+ l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
if arch == 'ARM':
- l += [OptCheck('userspace_hardening', 'my', 'INTEGRITY', 'y')]
- if arch == 'ARM64':
- l += [OptCheck('userspace_hardening', 'defconfig', 'ARM64_MTE', 'y')]
+ l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
if arch in ('ARM', 'X86_32'):
- l += [OptCheck('userspace_hardening', 'defconfig', 'VMSPLIT_3G', 'y')]
+ l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
if arch in ('X86_64', 'ARM64'):
- l += [OptCheck('userspace_hardening', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
+ l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
if arch in ('X86_32', 'ARM'):
- l += [OptCheck('userspace_hardening', 'my', 'ARCH_MMAP_RND_BITS', '16')]
+ l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
-# l += [OptCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
+# l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
def print_unknown_options(checklist, parsed_options):
known_options = []
- for opt in checklist:
- if hasattr(opt, 'opts'):
- for o in opt.opts:
- if hasattr(o, 'name'):
- known_options.append(o.name)
- else:
- known_options.append(opt.name)
+
+ for o1 in checklist:
+ if o1.type != 'complex':
+ known_options.append(o1.name)
+ continue
+ for o2 in o1.opts:
+ if o2.type != 'complex':
+ if hasattr(o2, 'name'):
+ known_options.append(o2.name)
+ continue
+ for o3 in o2.opts:
+ if o3.type == 'complex':
+ sys.exit('[!] ERROR: unexpected ComplexOptCheck inside {}'.format(o2.name))
+ if hasattr(o3, 'name'):
+ known_options.append(o3.name)
+
for option, value in parsed_options.items():
if option not in known_options:
- print('[?] No rule for option {} ({})'.format(option, value))
+ print('[?] No check for option {} ({})'.format(option, value))
def print_checklist(mode, checklist, with_results):
if mode == 'json':
- opts = []
+ output = []
for o in checklist:
- opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
- if with_results:
- opt.append(o.result)
- opts.append(opt)
- print(json.dumps(opts))
+ output.append(o.json_dump(with_results))
+ print(json.dumps(output))
return
# table header
if with_results:
sep_line_len += 30
print('=' * sep_line_len)
- print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
+ print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
if with_results:
- print('| {}'.format('check result'), end='')
+ print('| {}'.format('check result'), end='')
print()
print('=' * sep_line_len)
print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
-def perform_check(opt, parsed_options, kernel_version):
- if hasattr(opt, 'opts'):
- # prepare ComplexOptCheck
+def populate_simple_opt_with_data(opt, data, data_type):
+ if opt.type == 'complex':
+ sys.exit('[!] ERROR: unexpected ComplexOptCheck {}: {}'.format(opt.name, vars(opt)))
+ if data_type not in TYPES_OF_CHECKS:
+ sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
+
+ if data_type != opt.type:
+ return
+
+ if data_type == 'kconfig':
+ opt.state = data.get(opt.name, None)
+ elif data_type == 'version':
+ opt.ver = data
+ else:
+ sys.exit('[!] ERROR: unexpected data type "{}"'.format(data_type))
+
+
+def populate_opt_with_data(opt, data, data_type):
+ if opt.type == 'complex':
for o in opt.opts:
- if hasattr(o, 'opts'):
- # Recursion for nested ComplexOptChecks
- perform_check(o, parsed_options, kernel_version)
- if hasattr(o, 'state'):
- o.state = parsed_options.get(o.name, None)
- if hasattr(o, 'ver'):
- o.ver = kernel_version
+ if o.type == 'complex':
+ # Recursion for nested ComplexOptCheck objects
+ populate_opt_with_data(o, data, data_type)
+ else:
+ populate_simple_opt_with_data(o, data, data_type)
else:
- # prepare simple check, opt.state is mandatory
- if not hasattr(opt, 'state'):
- sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
- opt.state = parsed_options.get(opt.name, None)
- opt.check()
+ if opt.type != 'kconfig':
+ sys.exit('[!] ERROR: bad type "{}" for a simple check {}'.format(opt.type, opt.name))
+ populate_simple_opt_with_data(opt, data, data_type)
+
+
+def populate_with_data(checklist, data, data_type):
+ for opt in checklist:
+ populate_opt_with_data(opt, data, data_type)
-def perform_checks(checklist, parsed_options, kernel_version):
+def perform_checks(checklist):
for opt in checklist:
- perform_check(opt, parsed_options, kernel_version)
+ opt.check()
-def parse_config_file(parsed_options, fname):
+def parse_kconfig_file(parsed_options, fname):
with open(fname, 'r') as f:
opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
value = None
if opt_is_on.match(line):
- option, value = line[7:].split('=', 1)
+ option, value = line.split('=', 1)
elif opt_is_off.match(line):
- option, value = line[9:].split(' ', 1)
+ option, value = line[2:].split(' ', 1)
if value != 'is not set':
- sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
+ sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
if option in parsed_options:
- sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
+ sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
if option:
parsed_options[option] = value
- return parsed_options
-
def main():
# Report modes:
# * verbose mode for
- # - reporting about unknown kernel options in the config
+ # - reporting about unknown kernel options in the kconfig
# - verbose printing of ComplexOptCheck items
# * json mode for printing the results in JSON format
report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
parser.add_argument('-p', '--print', choices=supported_archs,
help='print security hardening preferences for the selected architecture')
parser.add_argument('-c', '--config',
- help='check the kernel config file against these preferences')
+ help='check the kernel kconfig file against these preferences')
parser.add_argument('-m', '--mode', choices=report_modes,
help='choose the report mode')
args = parser.parse_args()
if args.mode:
mode = args.mode
if mode != 'json':
- print("[+] Special report mode: {}".format(mode))
+ print('[+] Special report mode: {}'.format(mode))
config_checklist = []
if args.config:
if mode != 'json':
- print('[+] Config file to check: {}'.format(args.config))
+ print('[+] Kconfig file to check: {}'.format(args.config))
arch, msg = detect_arch(args.config, supported_archs)
if not arch:
if mode != 'json':
print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
- construct_checklist(config_checklist, arch)
- parsed_options = OrderedDict()
- parse_config_file(parsed_options, args.config)
- perform_checks(config_checklist, parsed_options, kernel_version)
+ # add relevant kconfig checks to the checklist
+ add_kconfig_checks(config_checklist, arch)
+
+ # populate the checklist with the parsed kconfig data
+ parsed_kconfig_options = OrderedDict()
+ parse_kconfig_file(parsed_kconfig_options, args.config)
+ populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
+ populate_with_data(config_checklist, kernel_version, 'version')
+
+ # now everything is ready for performing the checks
+ perform_checks(config_checklist)
+ # finally print the results
if mode == 'verbose':
- print_unknown_options(config_checklist, parsed_options)
+ print_unknown_options(config_checklist, parsed_kconfig_options)
print_checklist(mode, config_checklist, True)
sys.exit(0)
if args.print:
if mode in ('show_ok', 'show_fail'):
- sys.exit('[!] ERROR: please use "{}" mode for checking the kernel config'.format(mode))
+ sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
arch = args.print
- construct_checklist(config_checklist, arch)
+ add_kconfig_checks(config_checklist, arch)
if mode != 'json':
print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
print_checklist(mode, config_checklist, False)
projects / kconfig-hardened-check.git / blobdiff