- def __repr__(self):
- return '{} = {}'.format(self.name, self.state)
-
-
-def construct_opt_checks():
- checklist.append(OptCheck('BUG', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('RETPOLINE', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('X86_64', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('STRICT_KERNEL_RWX', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('STRICT_MODULE_RWX', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('DEBUG_WX', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('CC_STACKPROTECTOR', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('CC_STACKPROTECTOR_STRONG','y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('VMAP_STACK', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('THREAD_INFO_IN_TASK', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('SLUB_DEBUG', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('HARDENED_USERCOPY', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('MODULE_SIG', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('MODULE_SIG_ALL', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('MODULE_SIG_SHA512', 'y', 'ubuntu18', 'self_protection'))
- checklist.append(OptCheck('SYN_COOKIES', 'y', 'ubuntu18', 'self_protection')) # another reason?
- checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'ubuntu18', 'self_protection'))
+ if self.result.startswith('OK'):
+ return True, self.result
+ else:
+ return False, self.result
+
+
+class VerCheck:
+ def __init__(self, ver_expected):
+ self.ver_expected = ver_expected
+ self.result = None
+
+ def check(self):
+ if kernel_version[0] > self.ver_expected[0]:
+ self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
+ return True, self.result
+ if kernel_version[0] < self.ver_expected[0]:
+ self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
+ return False, self.result
+ 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])
+ return False, self.result
+
+
+class ComplexOptCheck:
+ def __init__(self, *opts):
+ self.opts = opts
+ self.result = None
+
+ @property
+ def name(self):
+ return self.opts[0].name
+
+ @property
+ def expected(self):
+ return self.opts[0].expected
+
+ @property
+ def state(self):
+ return self.opts[0].state
+
+ @property
+ def decision(self):
+ return self.opts[0].decision
+
+ @property
+ def reason(self):
+ return self.opts[0].reason
+
+
+class OR(ComplexOptCheck):
+ # self.opts[0] is the option that this OR-check is about.
+ # Use case:
+ # OR(<X_is_hardened>, <X_is_disabled>)
+ # OR(<X_is_hardened>, <X_is_hardened_old>)
+
+ def check(self):
+ if not self.opts:
+ sys.exit('[!] ERROR: invalid OR check')
+
+ for i, opt in enumerate(self.opts):
+ ret, msg = opt.check()
+ if ret:
+ if i == 0 or not hasattr(opt, 'name'):
+ self.result = opt.result
+ else:
+ self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
+ return True, self.result
+ self.result = self.opts[0].result
+ return False, self.result
+
+
+class AND(ComplexOptCheck):
+ # self.opts[0] is the option that this AND-check is about.
+ # Use case: AND(<suboption>, <main_option>)
+ # Suboption is not checked if checking of the main_option is failed.
+
+ def check(self):
+ for i, opt in reversed(list(enumerate(self.opts))):
+ ret, msg = opt.check()
+ if i == 0:
+ self.result = opt.result
+ return ret, self.result
+ elif not ret:
+ if hasattr(opt, 'name'):
+ self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
+ else:
+ self.result = opt.result
+ return False, self.result
+
+ sys.exit('[!] ERROR: invalid AND check')
+
+
+def detect_arch(fname):
+ with open(fname, 'r') as f:
+ arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
+ arch = None
+ if not json_mode:
+ print('[+] Trying to detect architecture in "{}"...'.format(fname))
+ for line in f.readlines():
+ if arch_pattern.match(line):
+ option, value = line[7:].split('=', 1)
+ if option in supported_archs:
+ if not arch:
+ arch = option
+ else:
+ return None, 'more than one supported architecture is detected'
+ if not arch:
+ return None, 'failed to detect architecture'
+ else:
+ return arch, 'OK'
+
+
+def detect_version(fname):
+ with open(fname, 'r') as f:
+ ver_pattern = re.compile("# Linux/.* Kernel Configuration")
+ if not json_mode:
+ print('[+] Trying to detect kernel version in "{}"...'.format(fname))
+ for line in f.readlines():
+ if ver_pattern.match(line):
+ line = line.strip()
+ if not json_mode:
+ print('[+] Found version line: "{}"'.format(line))
+ parts = line.split()
+ ver_str = parts[2]
+ ver_numbers = ver_str.split('.')
+ 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 None, 'no kernel version detected'
+
+
+def construct_checklist(checklist, arch):
+ modules_not_set = OptCheck('MODULES', 'is not set', 'kspp', 'cut_attack_surface')
+ devmem_not_set = OptCheck('DEVMEM', 'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
+
+ checklist.append(OptCheck('BUG', 'y', 'defconfig', 'self_protection'))
+ checklist.append(OR(OptCheck('STRICT_KERNEL_RWX', 'y', 'defconfig', 'self_protection'), \
+ OptCheck('DEBUG_RODATA', 'y', 'defconfig', 'self_protection'))) # before v4.11
+ checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection'), \
+ OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
+ checklist.append(OptCheck('SLUB_DEBUG', 'y', 'defconfig', 'self_protection'))
+ checklist.append(OR(OptCheck('STRICT_MODULE_RWX', 'y', 'defconfig', 'self_protection'), \
+ OptCheck('DEBUG_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
+ modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
+ checklist.append(OptCheck('GCC_PLUGINS', 'y', 'defconfig', 'self_protection'))
+ checklist.append(OR(OptCheck('REFCOUNT_FULL', 'y', 'defconfig', 'self_protection'), \
+ VerCheck((5, 5)))) # REFCOUNT_FULL is enabled by default since v5.5
+ if arch == 'X86_64' or arch == '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(OR(OptCheck('X86_UMIP', 'y', 'defconfig', 'self_protection'), \
+ OptCheck('X86_INTEL_UMIP', 'y', 'defconfig', 'self_protection')))
+ iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'defconfig', 'self_protection') # is needed for mitigating DMA attacks
+ checklist.append(iommu_support_is_set)
+ checklist.append(OptCheck('SYN_COOKIES', 'y', 'defconfig', 'self_protection')) # another reason?
+ if arch == 'X86_64':
+ checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
+ checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
+ checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'defconfig', 'self_protection'), \
+ iommu_support_is_set))
+ checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'defconfig', 'self_protection'), \
+ iommu_support_is_set))
+ if arch == 'ARM64':
+ 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('VMAP_STACK', 'y', 'defconfig', 'self_protection'))
+ if arch == 'X86_64' or arch == 'ARM64' or arch == '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('VMSPLIT_3G', 'y', 'defconfig', 'self_protection'))
+ 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':
+ checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR', 'y', 'defconfig', 'self_protection'))