kconfig-hardened-check.py

   1 #!/usr/bin/python3
   2
   3 #
   4 # This script helps me to check the Linux kernel Kconfig option list
   5 # against my hardening preferences for X86_64, ARM64, X86_32, and ARM.
   6 # Let the computers do their job!
   7 #
   8 # Author: Alexander Popov <alex.popov@linux.com>
   9 #
  10 # Please don't cry if my Python code looks like C.
  11 #
  12 #
  13 # N.B Hardening command line parameters:
  14 #    slub_debug=FZP
  15 #    slab_nomerge
  16 #    kernel.kptr_restrict=1
  17 #    page_alloc.shuffle=1
  18 #    iommu=force (does it help against DMA attacks?)
  19 #    page_poison=1 (if enabled)
  20 #    init_on_alloc=1
  21 #    init_on_free=1
  22 #    loadpin.enforce=1
  23 #
  24 #    Mitigations of CPU vulnerabilities:
  25 #       Аrch-independent:
  26 #           mitigations=auto,nosmt
  27 #       X86:
  28 #           spectre_v2=on
  29 #           pti=on
  30 #           spec_store_bypass_disable=on
  31 #           l1tf=full,force
  32 #           mds=full,nosmt
  33 #       ARM64:
  34 #           kpti=on
  35 #           ssbd=force-on
  36 #
  37 # N.B. Hardening sysctls:
  38 #    net.core.bpf_jit_harden=2
  39 #    kptr_restrict=2
  40 #    vm.unprivileged_userfaultfd=0
  41 #    kernel.perf_event_paranoid=3
  42 #    kernel.yama.ptrace_scope=1 (or even 3?)
  43 #    kernel.unprivileged_bpf_disabled=1
  44 #    fs.suid_dumpable=0
  45 #    fs.protected_symlinks = 1
  46 #    fs.protected_hardlinks = 1
  47 #    fs.protected_fifos = 2
  48 #    fs.protected_regular = 2
  49
  50 import sys
  51 from argparse import ArgumentParser
  52 from collections import OrderedDict
  53 import re
  54 import json
  55
  56 # debug_mode enables:
  57 #    - reporting about unknown kernel options in the config,
  58 #    - verbose printing of ComplexOptChecks (OR, AND).
  59 debug_mode = False
  60
  61 # json_mode is for printing results in JSON format
  62 json_mode = False
  63
  64 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
  65 config_checklist = []
  66 kernel_version = None
  67
  68
  69 class OptCheck:
  70     def __init__(self, name, expected, decision, reason):
  71         self.name = name
  72         self.expected = expected
  73         self.decision = decision
  74         self.reason = reason
  75         self.state = None
  76         self.result = None
  77
  78     def check(self):
  79         if self.expected == self.state:
  80             self.result = 'OK'
  81         elif self.state is None:
  82             if self.expected == 'is not set':
  83                 self.result = 'OK: not found'
  84             else:
  85                 self.result = 'FAIL: not found'
  86         else:
  87             self.result = 'FAIL: "' + self.state + '"'
  88
  89         if self.result.startswith('OK'):
  90             return True, self.result
  91         else:
  92             return False, self.result
  93
  94
  95 class VerCheck:
  96     def __init__(self, ver_expected):
  97         self.ver_expected = ver_expected
  98         self.result = None
  99
 100     def check(self):
 101         if kernel_version[0] > self.ver_expected[0]:
 102             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 103             return True, self.result
 104         if kernel_version[0] < self.ver_expected[0]:
 105             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 106             return False, self.result
 107         if kernel_version[1] >= self.ver_expected[1]:
 108             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 109             return True, self.result
 110         else:
 111             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 112             return False, self.result
 113
 114
 115 class ComplexOptCheck:
 116     def __init__(self, *opts):
 117         self.opts = opts
 118         self.result = None
 119
 120     @property
 121     def name(self):
 122         return self.opts[0].name
 123
 124     @property
 125     def expected(self):
 126         return self.opts[0].expected
 127
 128     @property
 129     def state(self):
 130         return self.opts[0].state
 131
 132     @property
 133     def decision(self):
 134         return self.opts[0].decision
 135
 136     @property
 137     def reason(self):
 138         return self.opts[0].reason
 139
 140
 141 class OR(ComplexOptCheck):
 142     # self.opts[0] is the option that this OR-check is about.
 143     # Use case:
 144     #     OR(<X_is_hardened>, <X_is_disabled>)
 145     #     OR(<X_is_hardened>, <X_is_hardened_old>)
 146
 147     def check(self):
 148         if not self.opts:
 149             sys.exit('[!] ERROR: invalid OR check')
 150
 151         for i, opt in enumerate(self.opts):
 152             ret, msg = opt.check()
 153             if ret:
 154                 if i == 0 or not hasattr(opt, 'name'):
 155                     self.result = opt.result
 156                 else:
 157                     self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
 158                 return True, self.result
 159         self.result = self.opts[0].result
 160         return False, self.result
 161
 162
 163 class AND(ComplexOptCheck):
 164     # self.opts[0] is the option that this AND-check is about.
 165     # Use case: AND(<suboption>, <main_option>)
 166     # Suboption is not checked if checking of the main_option is failed.
 167
 168     def check(self):
 169         for i, opt in reversed(list(enumerate(self.opts))):
 170             ret, msg = opt.check()
 171             if i == 0:
 172                 self.result = opt.result
 173                 return ret, self.result
 174             elif not ret:
 175                 if hasattr(opt, 'name'):
 176                     self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
 177                 else:
 178                     self.result = opt.result
 179                 return False, self.result
 180
 181         sys.exit('[!] ERROR: invalid AND check')
 182
 183
 184 def detect_arch(fname):
 185     with open(fname, 'r') as f:
 186         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 187         arch = None
 188         if not json_mode:
 189             print('[+] Trying to detect architecture in "{}"...'.format(fname))
 190         for line in f.readlines():
 191             if arch_pattern.match(line):
 192                 option, value = line[7:].split('=', 1)
 193                 if option in supported_archs:
 194                     if not arch:
 195                         arch = option
 196                     else:
 197                         return None, 'more than one supported architecture is detected'
 198         if not arch:
 199             return None, 'failed to detect architecture'
 200         else:
 201             return arch, 'OK'
 202
 203
 204 def detect_version(fname):
 205     with open(fname, 'r') as f:
 206         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 207         if not json_mode:
 208             print('[+] Trying to detect kernel version in "{}"...'.format(fname))
 209         for line in f.readlines():
 210             if ver_pattern.match(line):
 211                 line = line.strip()
 212                 if not json_mode:
 213                     print('[+] Found version line: "{}"'.format(line))
 214                 parts = line.split()
 215                 ver_str = parts[2]
 216                 ver_numbers = ver_str.split('.')
 217                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 218                     msg = 'failed to parse the version "' + ver_str + '"'
 219                     return None, msg
 220                 else:
 221                     return (int(ver_numbers[0]), int(ver_numbers[1])), None
 222         return None, 'no kernel version detected'
 223
 224
 225 def construct_checklist(checklist, arch):
 226     modules_not_set = OptCheck('MODULES',     'is not set', 'kspp', 'cut_attack_surface')
 227     devmem_not_set = OptCheck('DEVMEM',       'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
 228
 229     checklist.append(OptCheck('BUG',                         'y', 'defconfig', 'self_protection'))
 230     checklist.append(OR(OptCheck('STRICT_KERNEL_RWX',        'y', 'defconfig', 'self_protection'), \
 231                         OptCheck('DEBUG_RODATA',             'y', 'defconfig', 'self_protection'))) # before v4.11
 232     checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG',    'y', 'defconfig', 'self_protection'), \
 233                         OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
 234     checklist.append(OptCheck('SLUB_DEBUG',                  'y', 'defconfig', 'self_protection'))
 235     checklist.append(OR(OptCheck('STRICT_MODULE_RWX',        'y', 'defconfig', 'self_protection'), \
 236                         OptCheck('DEBUG_SET_MODULE_RONX',    'y', 'defconfig', 'self_protection'), \
 237                         modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
 238     checklist.append(OptCheck('GCC_PLUGINS',                 'y', 'defconfig', 'self_protection'))
 239     checklist.append(OR(OptCheck('REFCOUNT_FULL',               'y', 'defconfig', 'self_protection'), \
 240                         VerCheck((5, 5)))) # REFCOUNT_FULL is enabled by default since v5.5
 241     if arch == 'X86_64' or arch == 'X86_32':
 242         checklist.append(OptCheck('MICROCODE',                   'y', 'defconfig', 'self_protection')) # is needed for mitigating CPU bugs
 243         checklist.append(OptCheck('RETPOLINE',                   'y', 'defconfig', 'self_protection'))
 244         checklist.append(OptCheck('X86_SMAP',                    'y', 'defconfig', 'self_protection'))
 245         checklist.append(OR(OptCheck('X86_UMIP',                 'y', 'defconfig', 'self_protection'), \
 246                             OptCheck('X86_INTEL_UMIP',           'y', 'defconfig', 'self_protection')))
 247         iommu_support_is_set = OptCheck('IOMMU_SUPPORT',         'y', 'defconfig', 'self_protection') # is needed for mitigating DMA attacks
 248         checklist.append(iommu_support_is_set)
 249         checklist.append(OptCheck('SYN_COOKIES',                 'y', 'defconfig', 'self_protection')) # another reason?
 250     if arch == 'X86_64':
 251         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',        'y', 'defconfig', 'self_protection'))
 252         checklist.append(OptCheck('RANDOMIZE_MEMORY',            'y', 'defconfig', 'self_protection'))
 253         checklist.append(AND(OptCheck('INTEL_IOMMU',             'y', 'defconfig', 'self_protection'), \
 254                              iommu_support_is_set))
 255         checklist.append(AND(OptCheck('AMD_IOMMU',               'y', 'defconfig', 'self_protection'), \
 256                              iommu_support_is_set))
 257     if arch == 'ARM64':
 258         checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0',         'y', 'defconfig', 'self_protection'))
 259         checklist.append(OptCheck('HARDEN_EL2_VECTORS',          'y', 'defconfig', 'self_protection'))
 260         checklist.append(OptCheck('RODATA_FULL_DEFAULT_ENABLED', 'y', 'defconfig', 'self_protection'))
 261     if arch == 'X86_64' or arch == 'ARM64':
 262         checklist.append(OptCheck('VMAP_STACK',                  'y', 'defconfig', 'self_protection'))
 263     if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 264         checklist.append(OptCheck('RANDOMIZE_BASE',              'y', 'defconfig', 'self_protection'))
 265         checklist.append(OptCheck('THREAD_INFO_IN_TASK',         'y', 'defconfig', 'self_protection'))
 266     if arch == 'ARM':
 267         checklist.append(OptCheck('VMSPLIT_3G',                  'y', 'defconfig', 'self_protection'))
 268         checklist.append(OptCheck('CPU_SW_DOMAIN_PAN',           'y', 'defconfig', 'self_protection'))
 269         checklist.append(OptCheck('STACKPROTECTOR_PER_TASK',     'y', 'defconfig', 'self_protection'))
 270     if arch == 'ARM64' or arch == 'ARM':
 271         checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR',     'y', 'defconfig', 'self_protection'))
 272
 273     checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'))
 274     checklist.append(OptCheck('DEBUG_WX',                         'y', 'kspp', 'self_protection'))
 275     checklist.append(OptCheck('SCHED_STACK_END_CHECK',            'y', 'kspp', 'self_protection'))
 276     checklist.append(OptCheck('SLAB_FREELIST_HARDENED',           'y', 'kspp', 'self_protection'))
 277     checklist.append(OptCheck('SLAB_FREELIST_RANDOM',             'y', 'kspp', 'self_protection'))
 278     checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR',           'y', 'kspp', 'self_protection'))
 279     checklist.append(OptCheck('FORTIFY_SOURCE',                   'y', 'kspp', 'self_protection'))
 280     randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT',         'y', 'kspp', 'self_protection')
 281     checklist.append(randstruct_is_set)
 282     checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'))
 283     checklist.append(OptCheck('DEBUG_LIST',                       'y', 'kspp', 'self_protection'))
 284     checklist.append(OptCheck('DEBUG_SG',                         'y', 'kspp', 'self_protection'))
 285     checklist.append(OptCheck('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'))
 286     checklist.append(OptCheck('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'))
 287     hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY',      'y', 'kspp', 'self_protection')
 288     checklist.append(hardened_usercopy_is_set)
 289     checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK',   'is not set', 'kspp', 'self_protection'), \
 290                          hardened_usercopy_is_set))
 291     checklist.append(OR(OptCheck('MODULE_SIG',                    'y', 'kspp', 'self_protection'), \
 292                         modules_not_set))
 293     checklist.append(OR(OptCheck('MODULE_SIG_ALL',                'y', 'kspp', 'self_protection'), \
 294                         modules_not_set))
 295     checklist.append(OR(OptCheck('MODULE_SIG_SHA512',             'y', 'kspp', 'self_protection'), \
 296                         modules_not_set))
 297     checklist.append(OR(OptCheck('MODULE_SIG_FORCE',              'y', 'kspp', 'self_protection'), \
 298                         modules_not_set)) # refers to LOCK_DOWN_KERNEL
 299     checklist.append(OR(OptCheck('INIT_STACK_ALL',                'y', 'kspp', 'self_protection'), \
 300                       OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
 301     checklist.append(OptCheck('INIT_ON_ALLOC_DEFAULT_ON',         'y', 'kspp', 'self_protection'))
 302     checklist.append(OR(OptCheck('INIT_ON_FREE_DEFAULT_ON',       'y', 'kspp', 'self_protection'), \
 303                         OptCheck('PAGE_POISONING',                'y', 'kspp', 'self_protection'))) # before v5.3
 304     if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 305         stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK',       'y', 'kspp', 'self_protection')
 306         checklist.append(stackleak_is_set)
 307         checklist.append(AND(OptCheck('STACKLEAK_METRICS',         'is not set', 'clipos', 'self_protection'), \
 308                              stackleak_is_set))
 309         checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE', 'is not set', 'clipos', 'self_protection'), \
 310                              stackleak_is_set))
 311     if arch == 'X86_64' or arch == 'X86_32':
 312         checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',            '65536', 'kspp', 'self_protection'))
 313     if arch == 'X86_32':
 314         checklist.append(OptCheck('HIGHMEM64G',                       'y', 'kspp', 'self_protection'))
 315         checklist.append(OptCheck('X86_PAE',                          'y', 'kspp', 'self_protection'))
 316     if arch == 'ARM64':
 317         checklist.append(OptCheck('ARM64_SW_TTBR0_PAN',               'y', 'kspp', 'self_protection'))
 318     if arch == 'ARM64' or arch == 'ARM':
 319         checklist.append(OptCheck('SYN_COOKIES',                      'y', 'kspp', 'self_protection')) # another reason?
 320         checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',            '32768', 'kspp', 'self_protection'))
 321
 322     checklist.append(OptCheck('SECURITY_DMESG_RESTRICT',               'y', 'clipos', 'self_protection'))
 323     checklist.append(OptCheck('DEBUG_VIRTUAL',                         'y', 'clipos', 'self_protection'))
 324     checklist.append(OptCheck('STATIC_USERMODEHELPER',                 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
 325     checklist.append(OptCheck('SLAB_MERGE_DEFAULT',                    'is not set', 'clipos', 'self_protection')) # slab_nomerge
 326     checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
 327                          randstruct_is_set))
 328     checklist.append(OptCheck('CONFIG_RANDOM_TRUST_BOOTLOADER',        'is not set', 'clipos', 'self_protection'))
 329     if arch == 'X86_64' or arch == 'X86_32':
 330         checklist.append(OptCheck('RANDOM_TRUST_CPU',                      'is not set', 'clipos', 'self_protection'))
 331         checklist.append(AND(OptCheck('INTEL_IOMMU_SVM',                   'y', 'clipos', 'self_protection'), \
 332                              iommu_support_is_set))
 333         checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON',            'y', 'clipos', 'self_protection'), \
 334                              iommu_support_is_set))
 335
 336     checklist.append(OptCheck('SLUB_DEBUG_ON',                      'y', 'my', 'self_protection'))
 337     checklist.append(OptCheck('RESET_ATTACK_MITIGATION',            'y', 'my', 'self_protection')) # needs userspace support (systemd)
 338     if arch == 'X86_64':
 339         checklist.append(AND(OptCheck('AMD_IOMMU_V2',                   'y', 'my', 'self_protection'), \
 340                              iommu_support_is_set))
 341     if arch == 'X86_32':
 342         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',               'y', 'my', 'self_protection'))
 343
 344     if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 345         checklist.append(OptCheck('SECURITY',                               'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
 346     if arch == 'ARM':
 347         checklist.append(OptCheck('SECURITY',                               'y', 'kspp', 'security_policy')) # and choose your favourite LSM
 348     checklist.append(OptCheck('SECURITY_YAMA',                          'y', 'kspp', 'security_policy'))
 349     checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM',                  'y', 'clipos', 'security_policy'))
 350     checklist.append(OptCheck('SECURITY_LOCKDOWN_LSM_EARLY',            'y', 'clipos', 'security_policy'))
 351     checklist.append(OptCheck('LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y', 'clipos', 'security_policy'))
 352     loadpin_is_set = OptCheck('SECURITY_LOADPIN',                       'y', 'my', 'security_policy') # needs userspace support
 353     checklist.append(loadpin_is_set)
 354     checklist.append(AND(OptCheck('SECURITY_LOADPIN_ENFORCE',           'y', 'my', 'security_policy'), \
 355                          loadpin_is_set))
 356     checklist.append(OptCheck('SECURITY_SAFESETID',                     'y', 'my', 'security_policy'))
 357     checklist.append(OptCheck('SECURITY_WRITABLE_HOOKS',                'is not set', 'my', 'security_policy'))
 358
 359     checklist.append(OptCheck('SECCOMP',              'y', 'defconfig', 'cut_attack_surface'))
 360     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'defconfig', 'cut_attack_surface'))
 361     if arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 362         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'defconfig', 'cut_attack_surface'), \
 363                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 364
 365     checklist.append(modules_not_set)
 366     checklist.append(devmem_not_set)
 367     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 368                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 369     if arch == 'ARM':
 370         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'kspp', 'cut_attack_surface'), \
 371                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 372     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 373     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'kspp', 'cut_attack_surface'))
 374     checklist.append(OptCheck('DEVKMEM',              'is not set', 'kspp', 'cut_attack_surface'))
 375     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'kspp', 'cut_attack_surface'))
 376     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 377     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 378     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 379     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 380     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 381     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 382     if arch == 'X86_64':
 383         checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 384         checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 385         checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 386         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 387     if arch == 'ARM':
 388         checklist.append(OptCheck('OABI_COMPAT',          'is not set', 'kspp', 'cut_attack_surface'))
 389
 390     checklist.append(OptCheck('X86_PTDUMP',              'is not set', 'grsecurity', 'cut_attack_surface'))
 391     checklist.append(OptCheck('ZSMALLOC_STAT',           'is not set', 'grsecurity', 'cut_attack_surface'))
 392     checklist.append(OptCheck('PAGE_OWNER',              'is not set', 'grsecurity', 'cut_attack_surface'))
 393     checklist.append(OptCheck('DEBUG_KMEMLEAK',          'is not set', 'grsecurity', 'cut_attack_surface'))
 394     checklist.append(OptCheck('BINFMT_AOUT',             'is not set', 'grsecurity', 'cut_attack_surface'))
 395     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 396     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 397     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 398     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 399     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 400     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 401     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 402     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 403     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 404     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 405     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 406     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 407     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 408
 409     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 410     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 411     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 412     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 413     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 414
 415     checklist.append(OptCheck('STAGING',                  'is not set', 'clipos', 'cut_attack_surface'))
 416     checklist.append(OptCheck('KSM',                      'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
 417 #   checklist.append(OptCheck('IKCONFIG',                 'is not set', 'clipos', 'cut_attack_surface')) # no, this info is needed for this check :)
 418     checklist.append(OptCheck('KALLSYMS',                 'is not set', 'clipos', 'cut_attack_surface'))
 419     checklist.append(OptCheck('X86_VSYSCALL_EMULATION',   'is not set', 'clipos', 'cut_attack_surface'))
 420     checklist.append(OptCheck('MAGIC_SYSRQ',              'is not set', 'clipos', 'cut_attack_surface'))
 421     checklist.append(OptCheck('KEXEC_FILE',               'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 422     checklist.append(OptCheck('USER_NS',                  'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
 423     checklist.append(AND(OptCheck('LDISC_AUTOLOAD',           'is not set', 'clipos', 'cut_attack_surface'), \
 424                          VerCheck((5, 1)))) # LDISC_AUTOLOAD can be disabled since v5.1
 425
 426     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 427     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 428     checklist.append(OptCheck('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'))
 429     checklist.append(OptCheck('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'))
 430     checklist.append(OptCheck('FTRACE',               'is not set', 'my', 'cut_attack_surface'))
 431     checklist.append(OptCheck('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'))
 432     checklist.append(OptCheck('VIDEO_VIVID',          'is not set', 'my', 'cut_attack_surface'))
 433     if arch == 'X86_32':
 434         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'my', 'cut_attack_surface'))
 435
 436     checklist.append(OptCheck('INTEGRITY',       'y', 'defconfig', 'userspace_hardening'))
 437     if arch == 'ARM64':
 438         checklist.append(OptCheck('ARM64_PTR_AUTH',       'y', 'defconfig', 'userspace_hardening'))
 439     if arch == 'X86_64' or arch == 'ARM64':
 440         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '32', 'clipos', 'userspace_hardening'))
 441     if arch == 'X86_32' or arch == 'ARM':
 442         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '16', 'my', 'userspace_hardening'))
 443
 444 #   checklist.append(OptCheck('LKDTM',    'm', 'my', 'feature_test'))
 445
 446
 447 def print_opt(opt, with_results):
 448     print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
 449     if with_results:
 450         print('|   {}'.format(opt.result), end='')
 451     print()
 452
 453
 454 def print_checklist(checklist, with_results):
 455     if json_mode:
 456         opts = []
 457         for o in checklist:
 458             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 459             if with_results:
 460                 opt.append(o.result)
 461             opts.append(opt)
 462         print(json.dumps(opts))
 463         return
 464
 465     # table header
 466     sep_line_len = 91
 467     if with_results:
 468         sep_line_len += 30
 469     print('=' * sep_line_len)
 470     print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 471     if with_results:
 472         print('|   {}'.format('check result'), end='')
 473     print()
 474     print('=' * sep_line_len)
 475
 476     # table contents
 477     for opt in checklist:
 478         if debug_mode and hasattr(opt, 'opts'):
 479             print('    {:87}'.format('<<< ' + opt.__class__.__name__ + ' >>>'), end='')
 480             if with_results:
 481                 print('|   {}'.format(opt.result), end='')
 482             print()
 483             for o in opt.opts:
 484                 if hasattr(o, 'ver_expected'):
 485                     ver_req = 'kernel version >= ' + str(o.ver_expected[0]) + '.' + str(o.ver_expected[1])
 486                     print('{:<91}'.format(ver_req), end='')
 487                     if with_results:
 488                         print('|   {}'.format(o.result), end='')
 489                     print()
 490                 else:
 491                     print_opt(o, with_results)
 492         else:
 493             print_opt(opt, with_results)
 494         if debug_mode:
 495             print('-' * sep_line_len)
 496     print()
 497
 498
 499 def perform_checks(checklist, parsed_options):
 500     for opt in checklist:
 501         if hasattr(opt, 'opts'):
 502             # prepare ComplexOptCheck
 503             for o in opt.opts:
 504                 if hasattr(o, 'name'):
 505                     o.state = parsed_options.get(o.name, None)
 506         else:
 507             # prepare simple OptCheck
 508             if not hasattr(opt, 'name'):
 509                 sys.exit('[!] ERROR: bad OptCheck {}'.format(vars(opt)))
 510             opt.state = parsed_options.get(opt.name, None)
 511         opt.check()
 512
 513
 514 def check_config_file(checklist, fname):
 515     with open(fname, 'r') as f:
 516         parsed_options = OrderedDict()
 517         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 518         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 519
 520         if not json_mode:
 521             print('[+] Checking "{}" against {} hardening preferences...'.format(fname, arch))
 522         for line in f.readlines():
 523             line = line.strip()
 524             option = None
 525             value = None
 526
 527             if opt_is_on.match(line):
 528                 option, value = line[7:].split('=', 1)
 529             elif opt_is_off.match(line):
 530                 option, value = line[9:].split(' ', 1)
 531                 if value != 'is not set':
 532                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 533
 534             if option in parsed_options:
 535                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 536
 537             if option is not None:
 538                 parsed_options[option] = value
 539
 540         perform_checks(checklist, parsed_options)
 541
 542         if debug_mode:
 543             known_options = []
 544             for opt in checklist:
 545                 if hasattr(opt, 'opts'):
 546                     for o in opt.opts:
 547                         if hasattr(o, 'name'):
 548                             known_options.append(o.name)
 549                 else:
 550                     known_options.append(opt.name)
 551             for option, value in parsed_options.items():
 552                 if option not in known_options:
 553                     print('DEBUG: dunno about option {} ({})'.format(option, value))
 554
 555         print_checklist(checklist, True)
 556
 557
 558 if __name__ == '__main__':
 559     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 560     parser.add_argument('-p', '--print', choices=supported_archs,
 561                         help='print hardening preferences for selected architecture')
 562     parser.add_argument('-c', '--config',
 563                         help='check the config_file against these preferences')
 564     parser.add_argument('--debug', action='store_true',
 565                         help='enable verbose debug mode')
 566     parser.add_argument('--json', action='store_true',
 567                         help='print results in JSON format')
 568     args = parser.parse_args()
 569
 570     if args.debug:
 571         debug_mode = True
 572         print('[!] WARNING: debug mode is enabled')
 573     if args.json:
 574         json_mode = True
 575     if debug_mode and json_mode:
 576         sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
 577
 578     if args.config:
 579         arch, msg = detect_arch(args.config)
 580         if not arch:
 581             sys.exit('[!] ERROR: {}'.format(msg))
 582         elif not json_mode:
 583             print('[+] Detected architecture: {}'.format(arch))
 584
 585         kernel_version, msg = detect_version(args.config)
 586         if not kernel_version:
 587             sys.exit('[!] ERROR: {}'.format(msg))
 588         elif not json_mode:
 589             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 590
 591         construct_checklist(config_checklist, arch)
 592         check_config_file(config_checklist, args.config)
 593         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
 594         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
 595         if debug_mode:
 596             sys.exit(0)
 597         if not json_mode:
 598             print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
 599         sys.exit(0)
 600
 601     if args.print:
 602         arch = args.print
 603         construct_checklist(config_checklist, arch)
 604         if not json_mode:
 605             print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 606         print_checklist(config_checklist, False)
 607         sys.exit(0)
 608
 609     parser.print_help()