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 #    page_poison=1
  15 #    slub_debug=FZP
  16 #    slab_nomerge
  17 #    pti=on
  18 #    kernel.kptr_restrict=1
  19 #    lockdown=1
  20 #
  21 #    Mitigations of CPU vulnerabilities:
  22 #       Аrch-independent:
  23 #           mitigations=auto,nosmt
  24 #       X86:
  25 #           spectre_v2=on
  26 #           pti=on
  27 #           spec_store_bypass_disable=on
  28 #           l1tf=full,force
  29 #           mds=full,nosmt
  30 #       ARM64:
  31 #           ? CONFIG_HARDEN_BRANCH_PREDICTOR
  32 #           kpti=on
  33 #           ssbd=force-on
  34 #
  35 # N.B. Hardening sysctl's:
  36 #    net.core.bpf_jit_harden
  37 #    kptr_restrict=2
  38
  39 import sys
  40 from argparse import ArgumentParser
  41 from collections import OrderedDict
  42 import re
  43
  44 debug_mode = False  # set it to True to print the unknown options from the config
  45 json_mode = False   # if True, print results in JSON format
  46
  47 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
  48
  49 checklist = []
  50
  51
  52 class OptCheck:
  53     def __init__(self, name, expected, decision, reason):
  54         self.name = name
  55         self.expected = expected
  56         self.decision = decision
  57         self.reason = reason
  58         self.state = None
  59         self.result = None
  60
  61     def check(self):
  62         if self.expected == self.state:
  63             self.result = 'OK'
  64         elif self.state is None:
  65             if self.expected == 'is not set':
  66                 self.result = 'OK: not found'
  67             else:
  68                 self.result = 'FAIL: not found'
  69         else:
  70             self.result = 'FAIL: "' + self.state + '"'
  71
  72         if self.result.startswith('OK'):
  73             return True, self.result
  74         else:
  75             return False, self.result
  76
  77     def __repr__(self):
  78         return '{} = {}'.format(self.name, self.state)
  79
  80
  81 class ComplexOptCheck:
  82     def __init__(self, *opts):
  83         self.opts = opts
  84         self.result = None
  85
  86     @property
  87     def name(self):
  88         return self.opts[0].name
  89
  90     @property
  91     def expected(self):
  92         return self.opts[0].expected
  93
  94     @property
  95     def state(self):
  96         return self.opts[0].state
  97
  98     @property
  99     def decision(self):
 100         return self.opts[0].decision
 101
 102     @property
 103     def reason(self):
 104         return self.opts[0].reason
 105
 106
 107 class OR(ComplexOptCheck):
 108     # self.opts[0] is the option which this OR-check is about.
 109     # Use case:
 110     #     OR(<X_is_hardened>, <X_is_disabled>)
 111     #     OR(<X_is_hardened>, <X_is_hardened_old>)
 112
 113     def check(self):
 114         if not self.opts:
 115             sys.exit('[!] ERROR: invalid OR check')
 116
 117         for i, opt in enumerate(self.opts):
 118             ret, msg = opt.check()
 119             if ret:
 120                 if i == 0:
 121                     self.result = opt.result
 122                 else:
 123                     self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
 124                 return True, self.result
 125         self.result = self.opts[0].result
 126         return False, self.result
 127
 128
 129 class AND(ComplexOptCheck):
 130     # self.opts[0] is the option which this AND-check is about.
 131     # Use case: AND(<suboption>, <main_option>)
 132     # Suboption is not checked if checking of the main_option is failed.
 133
 134     def check(self):
 135         for i, opt in reversed(list(enumerate(self.opts))):
 136             ret, msg = opt.check()
 137             if i == 0:
 138                 self.result = opt.result
 139                 return ret, self.result
 140             elif not ret:
 141                 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
 142                 return False, self.result
 143
 144         sys.exit('[!] ERROR: invalid AND check')
 145
 146
 147 def detect_arch(fname):
 148     with open(fname, 'r') as f:
 149         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 150         arch = None
 151         msg = None
 152         if not json_mode:
 153             print('[+] Trying to detect architecture in "{}"...'.format(fname))
 154         for line in f.readlines():
 155             if arch_pattern.match(line):
 156                 option, value = line[7:].split('=', 1)
 157                 if option in supported_archs:
 158                     if not arch:
 159                         arch = option
 160                     else:
 161                         return None, 'more than one supported architecture is detected'
 162         if not arch:
 163             return None, 'failed to detect architecture'
 164         else:
 165             return arch, 'OK'
 166
 167
 168 def construct_checklist(arch):
 169     modules_not_set = OptCheck('MODULES',                'is not set', 'kspp', 'cut_attack_surface')
 170     devmem_not_set = OptCheck('DEVMEM',                  'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
 171
 172     checklist.append(OptCheck('BUG',                         'y', 'defconfig', 'self_protection'))
 173     checklist.append(OR(OptCheck('STRICT_KERNEL_RWX',        'y', 'defconfig', 'self_protection'), \
 174                         OptCheck('DEBUG_RODATA',             'y', 'defconfig', 'self_protection'))) # before v4.11
 175     checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG',    'y', 'defconfig', 'self_protection'), \
 176                         OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
 177     checklist.append(OptCheck('SLUB_DEBUG',                  'y', 'defconfig', 'self_protection'))
 178     checklist.append(OR(OptCheck('STRICT_MODULE_RWX',        'y', 'defconfig', 'self_protection'), \
 179                         OptCheck('DEBUG_SET_MODULE_RONX',    'y', 'defconfig', 'self_protection'), \
 180                         modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
 181     if debug_mode or arch == 'X86_64':
 182         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',    'y', 'defconfig', 'self_protection'))
 183         checklist.append(OptCheck('RANDOMIZE_MEMORY',        'y', 'defconfig', 'self_protection'))
 184     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 185         checklist.append(OptCheck('RANDOMIZE_BASE',              'y', 'defconfig', 'self_protection'))
 186         checklist.append(OptCheck('RETPOLINE',                   'y', 'defconfig', 'self_protection'))
 187         checklist.append(OptCheck('X86_SMAP',                    'y', 'defconfig', 'self_protection'))
 188         checklist.append(OptCheck('X86_INTEL_UMIP',              'y', 'defconfig', 'self_protection'))
 189         checklist.append(OptCheck('SYN_COOKIES',                 'y', 'defconfig', 'self_protection')) # another reason?
 190     if debug_mode or arch == 'ARM64':
 191         checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0',         'y', 'defconfig', 'self_protection'))
 192     if debug_mode or arch == 'X86_64' or arch == 'ARM64':
 193         checklist.append(OptCheck('VMAP_STACK',                  'y', 'defconfig', 'self_protection'))
 194     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 195         checklist.append(OptCheck('THREAD_INFO_IN_TASK',         'y', 'defconfig', 'self_protection'))
 196     if debug_mode or arch == 'ARM':
 197         checklist.append(OptCheck('VMSPLIT_3G',                  'y', 'defconfig', 'self_protection'))
 198         checklist.append(OptCheck('CPU_SW_DOMAIN_PAN',           'y', 'defconfig', 'self_protection'))
 199     if debug_mode or arch == 'ARM64' or arch == 'ARM':
 200         checklist.append(OptCheck('REFCOUNT_FULL',               'y', 'defconfig', 'self_protection'))
 201
 202     checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'))
 203     checklist.append(OptCheck('DEBUG_WX',                         'y', 'kspp', 'self_protection'))
 204     checklist.append(OptCheck('SCHED_STACK_END_CHECK',            'y', 'kspp', 'self_protection'))
 205     checklist.append(OptCheck('SLAB_FREELIST_HARDENED',           'y', 'kspp', 'self_protection'))
 206     checklist.append(OptCheck('SLAB_FREELIST_RANDOM',             'y', 'kspp', 'self_protection'))
 207     checklist.append(OptCheck('FORTIFY_SOURCE',                   'y', 'kspp', 'self_protection'))
 208     checklist.append(OptCheck('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'))
 209     randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT',         'y', 'kspp', 'self_protection')
 210     checklist.append(randstruct_is_set)
 211     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK',            'y', 'kspp', 'self_protection'))
 212     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL',  'y', 'kspp', 'self_protection'))
 213     checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'))
 214     checklist.append(OptCheck('DEBUG_LIST',                       'y', 'kspp', 'self_protection'))
 215     checklist.append(OptCheck('DEBUG_SG',                         'y', 'kspp', 'self_protection'))
 216     checklist.append(OptCheck('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'))
 217     checklist.append(OptCheck('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'))
 218     page_poisoning_is_set = OptCheck('PAGE_POISONING',            'y', 'kspp', 'self_protection')
 219     checklist.append(page_poisoning_is_set)
 220     hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY',      'y', 'kspp', 'self_protection')
 221     checklist.append(hardened_usercopy_is_set)
 222     checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK',   'is not set', 'kspp', 'self_protection'), \
 223                          hardened_usercopy_is_set))
 224     checklist.append(OR(OptCheck('MODULE_SIG',                    'y', 'kspp', 'self_protection'), \
 225                         modules_not_set))
 226     checklist.append(OR(OptCheck('MODULE_SIG_ALL',                'y', 'kspp', 'self_protection'), \
 227                         modules_not_set))
 228     checklist.append(OR(OptCheck('MODULE_SIG_SHA512',             'y', 'kspp', 'self_protection'), \
 229                         modules_not_set))
 230     checklist.append(OR(OptCheck('MODULE_SIG_FORCE',              'y', 'kspp', 'self_protection'), \
 231                         modules_not_set)) # refers to LOCK_DOWN_KERNEL
 232     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 233         checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',        '65536', 'kspp', 'self_protection'))
 234         checklist.append(OptCheck('REFCOUNT_FULL',                'y', 'kspp', 'self_protection'))
 235     if debug_mode or arch == 'X86_32':
 236         checklist.append(OptCheck('HIGHMEM64G',                   'y', 'kspp', 'self_protection'))
 237         checklist.append(OptCheck('X86_PAE',                      'y', 'kspp', 'self_protection'))
 238     if debug_mode or arch == 'ARM64':
 239         checklist.append(OptCheck('ARM64_SW_TTBR0_PAN',           'y', 'kspp', 'self_protection'))
 240         checklist.append(OptCheck('RANDOMIZE_BASE',               'y', 'kspp', 'self_protection'))
 241     if debug_mode or arch == 'ARM64' or arch == 'ARM':
 242         checklist.append(OptCheck('SYN_COOKIES',                  'y', 'kspp', 'self_protection')) # another reason?
 243         checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',        '32768', 'kspp', 'self_protection'))
 244
 245     checklist.append(OptCheck('LOCK_DOWN_KERNEL',                 'y', 'clipos', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
 246     checklist.append(OptCheck('SECURITY_DMESG_RESTRICT',          'y', 'clipos', 'self_protection'))
 247     checklist.append(OptCheck('DEBUG_VIRTUAL',                    'y', 'clipos', 'self_protection'))
 248     checklist.append(OptCheck('STATIC_USERMODEHELPER',            'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
 249     checklist.append(OptCheck('SLAB_MERGE_DEFAULT',                    'is not set', 'clipos', 'self_protection')) # slab_nomerge
 250     checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
 251                          randstruct_is_set))
 252     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 253         stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK',       'y', 'clipos', 'self_protection')
 254         checklist.append(stackleak_is_set)
 255         checklist.append(AND(OptCheck('STACKLEAK_METRICS',        'is not set', 'clipos', 'self_protection'), \
 256                              stackleak_is_set))
 257         checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE','is not set', 'clipos', 'self_protection'), \
 258                              stackleak_is_set))
 259     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 260         checklist.append(OptCheck('RANDOM_TRUST_CPU',             'is not set', 'clipos', 'self_protection'))
 261         checklist.append(OptCheck('MICROCODE',                    'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
 262         iommu_support_is_set = OptCheck('IOMMU_SUPPORT',          'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
 263         checklist.append(iommu_support_is_set)
 264         checklist.append(AND(OptCheck('INTEL_IOMMU',              'y', 'clipos', 'self_protection'), \
 265                              iommu_support_is_set))
 266         checklist.append(AND(OptCheck('INTEL_IOMMU_SVM',          'y', 'clipos', 'self_protection'), \
 267                              iommu_support_is_set))
 268         checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON',   'y', 'clipos', 'self_protection'), \
 269                              iommu_support_is_set))
 270
 271     if debug_mode or arch == 'X86_64':
 272         checklist.append(AND(OptCheck('AMD_IOMMU',                'y', 'my', 'self_protection'), \
 273                              iommu_support_is_set))
 274         checklist.append(AND(OptCheck('AMD_IOMMU_V2',             'y', 'my', 'self_protection'), \
 275                              iommu_support_is_set))
 276     checklist.append(OptCheck('SLUB_DEBUG_ON',                    'y', 'my', 'self_protection'))
 277     checklist.append(OptCheck('SECURITY_LOADPIN',                 'y', 'my', 'self_protection')) # needs userspace support
 278     checklist.append(OptCheck('RESET_ATTACK_MITIGATION',          'y', 'my', 'self_protection')) # needs userspace support (systemd)
 279     checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY',     'is not set', 'my', 'self_protection'), \
 280                          page_poisoning_is_set))
 281     checklist.append(AND(OptCheck('PAGE_POISONING_ZERO',          'is not set', 'my', 'self_protection'), \
 282                          page_poisoning_is_set))
 283     if debug_mode or arch == 'X86_32':
 284         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',         'y', 'my', 'self_protection'))
 285     if debug_mode or arch == 'ARM':
 286         checklist.append(OptCheck('STACKPROTECTOR_PER_TASK',      'y', 'my', 'self_protection'))
 287
 288     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 289         checklist.append(OptCheck('SECURITY',                'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
 290     if debug_mode or arch == 'ARM':
 291         checklist.append(OptCheck('SECURITY',                'y', 'kspp', 'security_policy')) # and choose your favourite LSM
 292     checklist.append(OptCheck('SECURITY_YAMA',               'y', 'kspp', 'security_policy'))
 293
 294     checklist.append(OptCheck('SECCOMP',              'y', 'defconfig', 'cut_attack_surface'))
 295     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'defconfig', 'cut_attack_surface'))
 296     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 297         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'defconfig', 'cut_attack_surface'), \
 298                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 299
 300     checklist.append(modules_not_set)
 301     checklist.append(devmem_not_set)
 302     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 303                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 304     if debug_mode or arch == 'ARM':
 305         checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
 306                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 307     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 308     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'kspp', 'cut_attack_surface'))
 309     checklist.append(OptCheck('DEVKMEM',              'is not set', 'kspp', 'cut_attack_surface'))
 310     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'kspp', 'cut_attack_surface'))
 311     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 312     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 313     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 314     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 315     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 316     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 317     if debug_mode or arch == 'X86_64':
 318         checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 319         checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 320         checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 321         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 322     if debug_mode or arch == 'ARM':
 323         checklist.append(OptCheck('OABI_COMPAT',          'is not set', 'kspp', 'cut_attack_surface'))
 324
 325     checklist.append(OptCheck('X86_PTDUMP',              'is not set', 'grsecurity', 'cut_attack_surface'))
 326     checklist.append(OptCheck('ZSMALLOC_STAT',           'is not set', 'grsecurity', 'cut_attack_surface'))
 327     checklist.append(OptCheck('PAGE_OWNER',              'is not set', 'grsecurity', 'cut_attack_surface'))
 328     checklist.append(OptCheck('DEBUG_KMEMLEAK',          'is not set', 'grsecurity', 'cut_attack_surface'))
 329     checklist.append(OptCheck('BINFMT_AOUT',             'is not set', 'grsecurity', 'cut_attack_surface'))
 330     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 331     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 332     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 333     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 334     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 335     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 336     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 337     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 338     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 339     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 340     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 341     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 342     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 343
 344     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 345     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 346     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 347     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 348     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 349
 350     checklist.append(OptCheck('KSM',                      'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
 351     checklist.append(OptCheck('IKCONFIG',                 'is not set', 'clipos', 'cut_attack_surface'))
 352     checklist.append(OptCheck('KALLSYMS',                 'is not set', 'clipos', 'cut_attack_surface'))
 353     checklist.append(OptCheck('X86_VSYSCALL_EMULATION',   'is not set', 'clipos', 'cut_attack_surface'))
 354     checklist.append(OptCheck('MAGIC_SYSRQ',              'is not set', 'clipos', 'cut_attack_surface'))
 355     checklist.append(OptCheck('KEXEC_FILE',               'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 356     checklist.append(OptCheck('USER_NS',                  'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
 357     checklist.append(OptCheck('LDISC_AUTOLOAD',           'is not set', 'clipos', 'cut_attack_surface'))
 358
 359     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 360     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 361     checklist.append(OptCheck('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'))
 362     checklist.append(OptCheck('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'))
 363     checklist.append(OptCheck('FTRACE',               'is not set', 'my', 'cut_attack_surface'))
 364     checklist.append(OptCheck('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'))
 365     if debug_mode or arch == 'X86_32':
 366         checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
 367
 368     if debug_mode or arch == 'ARM64':
 369         checklist.append(OptCheck('ARM64_PTR_AUTH',       'y', 'defconfig', 'userspace_protection'))
 370     if debug_mode or arch == 'X86_64' or arch == 'ARM64':
 371         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '32', 'clipos', 'userspace_protection'))
 372     if debug_mode or arch == 'X86_32' or arch == 'ARM':
 373         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '16', 'my', 'userspace_protection'))
 374
 375 #   checklist.append(OptCheck('LKDTM',    'm', 'my', 'feature_test'))
 376
 377
 378 def print_checks(arch=None):
 379     if json_mode:
 380         opts = []
 381         for o in checklist:
 382             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 383             if not arch:
 384                 opt.append(o.result)
 385             opts.append(opt)
 386         print(opts)
 387     else:
 388         if arch:
 389             print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 390
 391         # header
 392         print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 393         sep_line_len = 87
 394         if not arch:
 395             print('||{:^28}'.format('check result'), end='')
 396             sep_line_len = 116
 397         print()
 398
 399         print('=' * sep_line_len)
 400
 401         for opt in checklist:
 402             print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
 403             if not arch:
 404                 print('||{:^28}'.format(opt.result), end='')
 405             print()
 406         print()
 407
 408
 409 def get_option_state(options, name):
 410     return options.get(name, None)
 411
 412
 413 def perform_checks(parsed_options):
 414     for opt in checklist:
 415         if hasattr(opt, 'opts'):
 416             for o in opt.opts:
 417                 o.state = get_option_state(parsed_options, o.name)
 418         else:
 419             opt.state = get_option_state(parsed_options, opt.name)
 420         opt.check()
 421
 422
 423 def check_config_file(fname):
 424     with open(fname, 'r') as f:
 425         parsed_options = OrderedDict()
 426         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 427         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 428
 429         if not json_mode:
 430             print('[+] Checking "{}" against hardening preferences...'.format(fname))
 431         for line in f.readlines():
 432             line = line.strip()
 433             option = None
 434             value = None
 435
 436             if opt_is_on.match(line):
 437                 option, value = line[7:].split('=', 1)
 438             elif opt_is_off.match(line):
 439                 option, value = line[9:].split(' ', 1)
 440                 if value != 'is not set':
 441                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 442
 443             if option in parsed_options:
 444                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 445
 446             if option is not None:
 447                 parsed_options[option] = value
 448
 449         perform_checks(parsed_options)
 450
 451         if debug_mode:
 452             known_options = [opt.name for opt in checklist]
 453             for option, value in parsed_options.items():
 454                 if option not in known_options:
 455                     print("DEBUG: dunno about option {} ({})".format(option, value))
 456
 457         print_checks()
 458
 459
 460 if __name__ == '__main__':
 461     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 462     parser.add_argument('-p', '--print', choices=supported_archs,
 463                         help='print hardening preferences for selected architecture')
 464     parser.add_argument('-c', '--config',
 465                         help='check the config_file against these preferences')
 466     parser.add_argument('--debug', action='store_true',
 467                         help='enable internal debug mode')
 468     parser.add_argument('--json', action='store_true',
 469                         help='print results in JSON format')
 470     args = parser.parse_args()
 471
 472     if args.debug:
 473         debug_mode = True
 474     if args.json:
 475         json_mode = True
 476     if debug_mode and json_mode:
 477         sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
 478
 479     if args.config:
 480         arch, msg = detect_arch(args.config)
 481         if not arch:
 482             sys.exit('[!] ERROR: {}'.format(msg))
 483         elif not json_mode:
 484             print('[+] Detected architecture: {}'.format(arch))
 485
 486         construct_checklist(arch)
 487         check_config_file(args.config)
 488         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 489         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 490         if debug_mode:
 491             sys.exit(0)
 492         if not json_mode:
 493             print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
 494         sys.exit(0)
 495
 496     if args.print:
 497         arch = args.print
 498         construct_checklist(arch)
 499         print_checks(arch)
 500         sys.exit(0)
 501
 502     parser.print_help()