from collections import OrderedDict
import re
import json
+from .__about__ import __version__
+
+# pylint: disable=line-too-long,bad-whitespace,too-many-branches
+# pylint: disable=too-many-statements,global-statement
# debug_mode enables:
# - reporting about unknown kernel options in the config,
# json_mode is for printing results in JSON format
json_mode = False
-supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
+supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
kernel_version = None
if self.result.startswith('OK'):
return True, self.result
- else:
- return False, self.result
+ return False, self.result
+
+ def table_print(self, with_results):
+ print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(self.name, self.expected, self.decision, self.reason), end='')
+ if with_results:
+ print('| {}'.format(self.result), end='')
class VerCheck:
if kernel_version[1] >= self.ver_expected[1]:
self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
return True, self.result
- else:
- self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
+ self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
+ return False, self.result
+
+ def table_print(self, 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
+ self.result = 'OK: is present'
+ return True, self.result
+
+ def table_print(self, with_results):
+ print('CONFIG_{:<84}'.format(self.name + ' is present'), end='')
+ if with_results:
+ print('| {}'.format(self.result), end='')
class ComplexOptCheck:
def reason(self):
return self.opts[0].reason
+ def table_print(self, with_results):
+ if debug_mode:
+ print(' {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
+ if with_results:
+ print('| {}'.format(self.result), end='')
+ for o in self.opts:
+ print()
+ o.table_print(with_results)
+ else:
+ o = self.opts[0]
+ o.table_print(False)
+ if with_results:
+ print('| {}'.format(self.result), end='')
+
class OR(ComplexOptCheck):
# self.opts[0] is the option that this OR-check is about.
sys.exit('[!] ERROR: invalid OR check')
for i, opt in enumerate(self.opts):
- ret, msg = opt.check()
+ ret, _ = opt.check()
if ret:
if i == 0 or not hasattr(opt, 'expected'):
self.result = opt.result
def check(self):
for i, opt in reversed(list(enumerate(self.opts))):
- ret, msg = opt.check()
+ ret, _ = opt.check()
if i == 0:
self.result = opt.result
return ret, self.result
- elif not ret:
+ if not ret:
if hasattr(opt, 'expected'):
self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
else:
print('[+] Trying to detect architecture in "{}"...'.format(fname))
for line in f.readlines():
if arch_pattern.match(line):
- option, value = line[7:].split('=', 1)
+ option, _ = line[7:].split('=', 1)
if option in supported_archs:
if not arch:
arch = option
return None, 'more than one supported architecture is detected'
if not arch:
return None, 'failed to detect architecture'
- else:
- return arch, 'OK'
+ return arch, 'OK'
def detect_version(fname):
if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
msg = 'failed to parse the version "' + ver_str + '"'
return None, msg
- else:
- return (int(ver_numbers[0]), int(ver_numbers[1])), None
+ return (int(ver_numbers[0]), int(ver_numbers[1])), None
return None, 'no kernel version detected'
VerCheck((5, 5)))) # REFCOUNT_FULL is enabled by default since v5.5
iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'defconfig', 'self_protection') # is needed for mitigating DMA attacks
checklist.append(iommu_support_is_set)
- if arch == 'X86_64' or arch == 'X86_32':
+ if arch in ('X86_64', 'X86_32'):
checklist.append(OptCheck('MICROCODE', 'y', 'defconfig', 'self_protection')) # is needed for mitigating CPU bugs
checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('X86_SMAP', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('HARDEN_EL2_VECTORS', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
- if arch == 'X86_64' or arch == 'ARM64':
+ checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'self_protection'))
+ if arch in ('X86_64', 'ARM64'):
checklist.append(OptCheck('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
- if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
+ if arch in ('X86_64', 'ARM64', 'X86_32'):
checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'defconfig', 'self_protection'))
if arch == 'ARM':
checklist.append(OptCheck('CPU_SW_DOMAIN_PAN', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'defconfig', 'self_protection'))
- if arch == 'ARM64' or arch == 'ARM':
+ if arch in ('ARM64', 'ARM'):
checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON', 'y', 'kspp', 'self_protection'))
checklist.append(OR(OptCheck('INIT_ON_FREE_DEFAULT_ON', 'y', 'kspp', 'self_protection'), \
OptCheck('PAGE_POISONING', 'y', 'kspp', 'self_protection'))) # before v5.3
- if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
+ if arch in ('X86_64', 'ARM64', 'X86_32'):
stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'kspp', 'self_protection')
checklist.append(stackleak_is_set)
checklist.append(AND(OptCheck('STACKLEAK_METRICS', 'is not set', 'clipos', 'self_protection'), \
stackleak_is_set))
checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
stackleak_is_set))
- if arch == 'X86_64' or arch == 'X86_32':
+ if arch in ('X86_64', 'X86_32'):
checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
if arch == 'X86_32':
checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
if arch == 'ARM64':
checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
- if arch == 'ARM64' or arch == 'ARM':
+ if arch in ('ARM64', 'ARM'):
checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
randstruct_is_set))
checklist.append(OptCheck('RANDOM_TRUST_BOOTLOADER', 'is not set', 'clipos', 'self_protection'))
checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
- if arch == 'X86_64' or arch == 'X86_32':
+ if arch in ('X86_64', 'X86_32'):
checklist.append(AND(OptCheck('INTEL_IOMMU_SVM', 'y', 'clipos', 'self_protection'), \
iommu_support_is_set))
checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON', 'y', 'clipos', 'self_protection'), \
checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
iommu_support_is_set))
- if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
+ if arch in ('X86_64', 'ARM64', 'X86_32'):
checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
if arch == 'ARM':
checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
- if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
+ if arch in ('X86_64', 'ARM64', 'X86_32'):
checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'defconfig', 'cut_attack_surface'), \
devmem_not_set)) # refers to LOCKDOWN
checklist.append(OptCheck('DEBUG_FS', 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
+ checklist.append(OptCheck('DRM_LEGACY', 'is not set', 'maintainer', 'cut_attack_surface'))
+ checklist.append(OptCheck('FB', 'is not set', 'maintainer', 'cut_attack_surface'))
+ checklist.append(OptCheck('VT', 'is not set', 'maintainer', 'cut_attack_surface'))
+
checklist.append(OptCheck('ACPI_TABLE_UPGRADE', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('X86_IOPL_IOPERM', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('EFI_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('BPF_SYSCALL', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('MMIOTRACE_TEST', 'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCKDOWN
- if arch == 'X86_64' or arch == 'X86_32':
+ if arch in ('X86_64', 'X86_32'):
checklist.append(OptCheck('X86_INTEL_TSX_MODE_OFF', 'y', 'clipos', 'cut_attack_surface')) # tsx=off
checklist.append(OptCheck('STAGING', 'is not set', 'clipos', 'cut_attack_surface'))
checklist.append(OptCheck('KSM', 'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
checklist.append(OptCheck('X86_MSR', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('X86_CPUID', 'is not set', 'clipos', 'cut_attack_surface'))
checklist.append(AND(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'), \
- VerCheck((5, 1)))) # LDISC_AUTOLOAD can be disabled since v5.1
+ PresenceCheck('LDISC_AUTOLOAD')))
checklist.append(OptCheck('AIO', 'is not set', 'grapheneos', 'cut_attack_surface'))
checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCKDOWN
checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
checklist.append(OptCheck('VIDEO_VIVID', 'is not set', 'my', 'cut_attack_surface'))
+ checklist.append(OptCheck('INPUT_EVBUG', 'is not set', 'my', 'cut_attack_surface')) # Can be used as a keylogger
checklist.append(OptCheck('INTEGRITY', 'y', 'defconfig', 'userspace_hardening'))
- if arch == 'ARM64':
- checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_hardening'))
- if arch == 'ARM' or arch == 'X86_32':
+ if arch in ('ARM', 'X86_32'):
checklist.append(OptCheck('VMSPLIT_3G', 'y', 'defconfig', 'userspace_hardening'))
- if arch == 'X86_64' or arch == 'ARM64':
+ if arch in ('X86_64', 'ARM64'):
checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_hardening'))
- if arch == 'X86_32' or arch == 'ARM':
+ if arch in ('X86_32', 'ARM'):
checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_hardening'))
# checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
-def print_opt(opt, with_results):
- print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
- if with_results:
- print('| {}'.format(opt.result), end='')
- print()
-
-
def print_checklist(checklist, with_results):
if json_mode:
opts = []
# table contents
for opt in checklist:
- if debug_mode and hasattr(opt, 'opts'):
- print(' {:87}'.format('<<< ' + opt.__class__.__name__ + ' >>>'), end='')
- if with_results:
- print('| {}'.format(opt.result), end='')
- print()
- for o in opt.opts:
- if hasattr(o, 'ver_expected'):
- ver_req = 'kernel version >= ' + str(o.ver_expected[0]) + '.' + str(o.ver_expected[1])
- print('{:<91}'.format(ver_req), end='')
- if with_results:
- print('| {}'.format(o.result), end='')
- print()
- else:
- print_opt(o, with_results)
- else:
- print_opt(opt, with_results)
+ opt.table_print(with_results)
+ print()
if debug_mode:
print('-' * sep_line_len)
print()
config_checklist = []
- parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
+ parser = ArgumentParser(prog='kconfig-hardened-check',
+ description='Checks the hardening options in the Linux kernel config')
parser.add_argument('-p', '--print', choices=supported_archs,
help='print hardening preferences for selected architecture')
parser.add_argument('-c', '--config',
help='enable verbose debug mode')
parser.add_argument('--json', action='store_true',
help='print results in JSON format')
+ parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
args = parser.parse_args()
if args.debug:
projects / kconfig-hardened-check.git / blobdiff