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.state = None
self.result = None
+ @property
+ def type(self):
+ return 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:
self.result = 'FAIL: "' + self.state + '"'
def table_print(self, _mode, with_results):
- print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, 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 PresenceCheck:
- def __init__(self, name, type):
- self.type = type
- if self.type == 'kconfig':
- self.name = 'CONFIG_' + name
- else:
- sys.exit('[!] ERROR: unsupported type "{}" for {}'.format(type, self.__class__.__name__))
- self.state = None
- self.result = None
-
- def check(self):
- if self.state is None:
- self.result = 'FAIL: not present'
- return
- self.result = 'OK: is present'
-
- def table_print(self, _mode, with_results):
- print('{:<91}'.format(self.name + ' is present'), end='')
- if with_results:
- print('| {}'.format(self.result), end='')
-
-
class ComplexOptCheck:
def __init__(self, *opts):
self.opts = opts
for i, opt in enumerate(self.opts):
opt.check()
if opt.result.startswith('OK'):
- if opt.result == 'OK' and i != 0:
- # Simple OK is not enough for additional checks, add more info:
- self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
- else:
- self.result = opt.result
+ 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
elif opt.result == 'FAIL: not present':
self.result = 'FAIL: {} not present'.format(opt.name)
else:
- # This FAIL message is self-explaining.
+ # VersionCheck provides enough info
self.result = opt.result
+ if not opt.result.startswith('FAIL: version'):
+ sys.exit('[!] ERROR: unexpected FAIL description "{}"'.format(opt.result))
return
sys.exit('[!] ERROR: invalid AND check')
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'),
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')]
+ l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
if arch == 'ARM':
l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', '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 = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', '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')]
- l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
if arch in ('X86_64', 'X86_32'):
+ l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
if arch in ('ARM64', 'ARM'):
l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
if arch == 'ARM':
l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
- l += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
- KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
+ 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 += [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(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
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
+ l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
# 'cut_attack_surface', 'grapheneos'
l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', '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_MSR', 'is not set')] # refers to LOCKDOWN
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'),
- PresenceCheck('LDISC_AUTOLOAD', 'kconfig'))]
+ KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
if arch in ('X86_64', 'X86_32'):
l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
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
+ l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
# 'harden_userspace'
if arch in ('X86_64', 'ARM64', 'X86_32'):
l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
if arch == 'ARM':
l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
- if arch == 'ARM64':
- l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_MTE', 'y')]
if arch in ('ARM', 'X86_32'):
l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
if arch in ('X86_64', 'ARM64'):
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 opt.type not in TYPES_OF_CHECKS:
+ sys.exit('[!] ERROR: invalid opt type "{}" for {}'.format(opt.type, opt.name))
if data_type not in TYPES_OF_CHECKS:
sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
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):
projects / kconfig-hardened-check.git / blobdiff