# kpti=on
# ssbd=force-on
#
-# N.B. Hardening sysctl's:
-# net.core.bpf_jit_harden
+# N.B. Hardening sysctls:
+# net.core.bpf_jit_harden=2
# kptr_restrict=2
+# vm.unprivileged_userfaultfd=0
+# kernel.perf_event_paranoid=3
+# kernel.yama.ptrace_scope=1
+# kernel.unprivileged_bpf_disabled=1
import sys
from argparse import ArgumentParser
from collections import OrderedDict
import re
+import json
debug_mode = False # set it to True to print the unknown options from the config
+json_mode = False # if True, print results in JSON format
supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
-checklist = []
-
class OptCheck:
def __init__(self, name, expected, decision, reason):
arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
arch = None
msg = None
- print('[+] Trying to detect architecture in "{}"...'.format(fname))
+ 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)
return arch, 'OK'
-def construct_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
+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_SET_MODULE_RONX', 'y', 'defconfig', 'self_protection'), \
modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
if debug_mode or arch == 'X86_64':
- checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
- checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
+ checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'defconfig', 'self_protection'))
+ checklist.append(OptCheck('RANDOMIZE_MEMORY', 'y', 'defconfig', 'self_protection'))
if debug_mode or arch == 'X86_64' or arch == 'X86_32':
checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('RETPOLINE', 'y', 'defconfig', 'self_protection'))
checklist.append(OptCheck('SCHED_STACK_END_CHECK', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('SLAB_FREELIST_HARDENED', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('SLAB_FREELIST_RANDOM', 'y', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('FORTIFY_SOURCE', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('GCC_PLUGINS', 'y', 'kspp', 'self_protection'))
- checklist.append(OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection'))
- checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK', 'y', 'kspp', 'self_protection'))
- checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection'))
+ randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT', 'y', 'kspp', 'self_protection')
+ checklist.append(randstruct_is_set)
checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('DEBUG_LIST', 'y', 'kspp', 'self_protection'))
checklist.append(OptCheck('DEBUG_SG', 'y', 'kspp', 'self_protection'))
checklist.append(OR(OptCheck('MODULE_SIG_FORCE', 'y', 'kspp', 'self_protection'), \
modules_not_set)) # refers to LOCK_DOWN_KERNEL
if debug_mode or arch == 'X86_64' or arch == 'X86_32':
- checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
- checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '65536', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('REFCOUNT_FULL', 'y', 'kspp', 'self_protection'))
if debug_mode or arch == 'X86_32':
- checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
- checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('HIGHMEM64G', 'y', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('X86_PAE', 'y', 'kspp', 'self_protection'))
if debug_mode or arch == 'ARM64':
- checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
- checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('ARM64_SW_TTBR0_PAN', 'y', 'kspp', 'self_protection'))
+ checklist.append(OptCheck('RANDOMIZE_BASE', 'y', 'kspp', 'self_protection'))
if debug_mode or arch == 'ARM64' or arch == 'ARM':
- checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
- checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
-
+ checklist.append(OptCheck('SYN_COOKIES', 'y', 'kspp', 'self_protection')) # another reason?
+ checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR', '32768', 'kspp', 'self_protection'))
+
+ checklist.append(OptCheck('LOCK_DOWN_KERNEL', 'y', 'clipos', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
+ checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'clipos', 'self_protection'))
+ checklist.append(OptCheck('DEBUG_VIRTUAL', 'y', 'clipos', 'self_protection'))
+ checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
+ checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'clipos', 'self_protection')) # slab_nomerge
+ checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
+ randstruct_is_set))
if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
- checklist.append(OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'my', 'self_protection'))
- checklist.append(OptCheck('LOCK_DOWN_KERNEL', 'y', 'my', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
- checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
- checklist.append(OptCheck('SECURITY_DMESG_RESTRICT', 'y', 'my', 'self_protection'))
- checklist.append(OptCheck('STATIC_USERMODEHELPER', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
- checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'self_protection')) # needs userspace support
- checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
- checklist.append(OptCheck('SLAB_MERGE_DEFAULT', 'is not set', 'my', 'self_protection')) # slab_nomerge
- checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY', 'is not set', 'my', 'self_protection'), \
+ stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK', 'y', 'clipos', '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 debug_mode or arch == 'X86_64' or arch == 'X86_32':
+ checklist.append(OptCheck('RANDOM_TRUST_CPU', 'is not set', 'clipos', 'self_protection'))
+ checklist.append(OptCheck('MICROCODE', 'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
+ iommu_support_is_set = OptCheck('IOMMU_SUPPORT', 'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
+ checklist.append(iommu_support_is_set)
+ checklist.append(AND(OptCheck('INTEL_IOMMU', 'y', 'clipos', 'self_protection'), \
+ iommu_support_is_set))
+ 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'), \
+ iommu_support_is_set))
+
+ checklist.append(OR(OptCheck('INIT_STACK_ALL', 'y', 'my', 'self_protection'), \
+ OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
+ checklist.append(OptCheck('SLUB_DEBUG_ON', 'y', 'my', 'self_protection'))
+ checklist.append(OptCheck('SECURITY_LOADPIN', 'y', 'my', 'self_protection')) # needs userspace support
+ checklist.append(OptCheck('RESET_ATTACK_MITIGATION', 'y', 'my', 'self_protection')) # needs userspace support (systemd)
+ checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY', 'is not set', 'my', 'self_protection'), \
page_poisoning_is_set))
- checklist.append(AND(OptCheck('PAGE_POISONING_ZERO', 'is not set', 'my', 'self_protection'), \
+ checklist.append(AND(OptCheck('PAGE_POISONING_ZERO', 'is not set', 'my', 'self_protection'), \
page_poisoning_is_set))
+ if debug_mode or arch == 'X86_64':
+ checklist.append(AND(OptCheck('AMD_IOMMU', 'y', 'my', 'self_protection'), \
+ iommu_support_is_set))
+ checklist.append(AND(OptCheck('AMD_IOMMU_V2', 'y', 'my', 'self_protection'), \
+ iommu_support_is_set))
if debug_mode or arch == 'X86_32':
- checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
+ checklist.append(OptCheck('PAGE_TABLE_ISOLATION', 'y', 'my', 'self_protection'))
if debug_mode or arch == 'ARM':
- checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'my', 'self_protection'))
+ checklist.append(OptCheck('STACKPROTECTOR_PER_TASK', 'y', 'my', 'self_protection'))
if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
- checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy'))
+ checklist.append(OptCheck('SECURITY', 'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
if debug_mode or arch == 'ARM':
- checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy'))
- checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
- checklist.append(OptCheck('SECURITY_SELINUX_DISABLE', 'is not set', 'kspp', 'security_policy'))
+ checklist.append(OptCheck('SECURITY', 'y', 'kspp', 'security_policy')) # and choose your favourite LSM
+ checklist.append(OptCheck('SECURITY_YAMA', 'y', 'kspp', 'security_policy'))
checklist.append(OptCheck('SECCOMP', 'y', 'defconfig', 'cut_attack_surface'))
checklist.append(OptCheck('SECCOMP_FILTER', 'y', 'defconfig', 'cut_attack_surface'))
checklist.append(OR(OptCheck('IO_STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
devmem_not_set)) # refers to LOCK_DOWN_KERNEL
if debug_mode or arch == 'ARM':
- checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
+ checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
devmem_not_set)) # refers to LOCK_DOWN_KERNEL
checklist.append(OptCheck('ACPI_CUSTOM_METHOD', 'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
checklist.append(OptCheck('COMPAT_BRK', 'is not set', 'kspp', 'cut_attack_surface'))
checklist.append(OptCheck('KALLSYMS', 'is not set', 'clipos', 'cut_attack_surface'))
checklist.append(OptCheck('X86_VSYSCALL_EMULATION', 'is not set', 'clipos', 'cut_attack_surface'))
checklist.append(OptCheck('MAGIC_SYSRQ', 'is not set', 'clipos', 'cut_attack_surface'))
+ checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
+ checklist.append(OptCheck('USER_NS', 'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
+ checklist.append(OptCheck('LDISC_AUTOLOAD', 'is not set', 'clipos', 'cut_attack_surface'))
checklist.append(OptCheck('MMIOTRACE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
- checklist.append(OptCheck('KEXEC_FILE', 'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
checklist.append(OptCheck('LIVEPATCH', 'is not set', 'my', 'cut_attack_surface'))
- checklist.append(OptCheck('USER_NS', 'is not set', 'my', 'cut_attack_surface')) # user.max_user_namespaces=0
checklist.append(OptCheck('IP_DCCP', 'is not set', 'my', 'cut_attack_surface'))
checklist.append(OptCheck('IP_SCTP', 'is not set', 'my', 'cut_attack_surface'))
checklist.append(OptCheck('FTRACE', 'is not set', 'my', 'cut_attack_surface'))
checklist.append(OptCheck('BPF_JIT', 'is not set', 'my', 'cut_attack_surface'))
if debug_mode or arch == 'X86_32':
- checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
+ checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
if debug_mode or arch == 'ARM64':
checklist.append(OptCheck('ARM64_PTR_AUTH', 'y', 'defconfig', 'userspace_protection'))
if debug_mode or arch == 'X86_64' or arch == 'ARM64':
- checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'my', 'userspace_protection'))
+ checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '32', 'clipos', 'userspace_protection'))
if debug_mode or arch == 'X86_32' or arch == 'ARM':
checklist.append(OptCheck('ARCH_MMAP_RND_BITS', '16', 'my', 'userspace_protection'))
# checklist.append(OptCheck('LKDTM', 'm', 'my', 'feature_test'))
-def print_checklist(arch):
- print('[+] Printing kernel hardening preferences for {}...'.format(arch))
- print('{:^40}|{:^13}|{:^10}|{:^20}'.format(
- 'option name', 'desired val', 'decision', 'reason'))
- print('=' * 87)
- for opt in checklist:
- print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(
- opt.name, opt.expected, opt.decision, opt.reason))
+def print_checklist(checklist, with_results):
+ if json_mode:
+ opts = []
+ 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))
+ return
+
+ # header
+ print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
+ sep_line_len = 86
+ if with_results:
+ print('||{:^28}'.format('check result'), end='')
+ sep_line_len += 30
print()
+ print('=' * sep_line_len)
-def print_check_results():
- print('{:^40}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
- 'option name', 'desired val', 'decision', 'reason', 'check result'))
- print('=' * 116)
for opt in checklist:
- print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
- opt.name, opt.expected, opt.decision, opt.reason, opt.result))
+ print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
+ if with_results:
+ print('||{:^28}'.format(opt.result), end='')
+ print()
print()
return options.get(name, None)
-def perform_checks(parsed_options):
+def perform_checks(checklist, parsed_options):
for opt in checklist:
if hasattr(opt, 'opts'):
for o in opt.opts:
opt.check()
-def check_config_file(fname):
+def check_config_file(checklist, fname):
with open(fname, 'r') as f:
parsed_options = OrderedDict()
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")
- print('[+] Checking "{}" against hardening preferences...'.format(fname))
+ if not json_mode:
+ print('[+] Checking "{}" against hardening preferences...'.format(fname))
for line in f.readlines():
line = line.strip()
option = None
if option is not None:
parsed_options[option] = value
- perform_checks(parsed_options)
+ perform_checks(checklist, parsed_options)
if debug_mode:
known_options = [opt.name for opt in checklist]
if option not in known_options:
print("DEBUG: dunno about option {} ({})".format(option, value))
- print_check_results()
+ print_checklist(checklist, True)
if __name__ == '__main__':
+ config_checklist = []
+
parser = ArgumentParser(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')
help='check the config_file against these preferences')
parser.add_argument('--debug', action='store_true',
help='enable internal debug mode')
+ parser.add_argument('--json', action='store_true',
+ help='print results in JSON format')
args = parser.parse_args()
if args.debug:
debug_mode = True
+ if args.json:
+ json_mode = True
+ if debug_mode and json_mode:
+ sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
if args.config:
arch, msg = detect_arch(args.config)
if not arch:
sys.exit('[!] ERROR: {}'.format(msg))
- else:
+ elif not json_mode:
print('[+] Detected architecture: {}'.format(arch))
- construct_checklist(arch)
- check_config_file(args.config)
- error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
- ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
+ construct_checklist(config_checklist, arch)
+ check_config_file(config_checklist, args.config)
+ error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
+ ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
if debug_mode:
sys.exit(0)
- print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
+ if not json_mode:
+ print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
sys.exit(0)
if args.print:
arch = args.print
- construct_checklist(arch)
- print_checklist(arch)
+ construct_checklist(config_checklist, arch)
+ if not json_mode:
+ print('[+] Printing kernel hardening preferences for {}...'.format(arch))
+ print_checklist(config_checklist, False)
sys.exit(0)
parser.print_help()
projects / kconfig-hardened-check.git / blobdiff