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. Let the computers do their job!
   6 #
   7 # Author: Alexander Popov <alex.popov@linux.com>
   8 #
   9 # Please don't cry if my Python code looks like C.
  10 #
  11 #
  12 # N.B Hardening command line parameters:
  13 #    page_poison=1
  14 #    slub_debug=FZP
  15 #    slab_nomerge
  16 #    pti=on
  17 #    kernel.kptr_restrict=1
  18 #    lockdown=1
  19 #
  20 #    spectre_v2=on
  21 #    pti=on
  22 #    spec_store_bypass_disable=on
  23 #    l1tf=full,force
  24 #
  25 #
  26 # N.B. Hardening sysctl's:
  27 #    net.core.bpf_jit_harden
  28 #
  29 #
  30 # TODO: add hardening preferences for ARM
  31
  32 import sys
  33 from argparse import ArgumentParser
  34 from collections import OrderedDict
  35 import re
  36
  37 debug_mode = False  # set it to True to print the unknown options from the config
  38
  39 supported_archs = [ 'X86_64', 'X86_32' ]
  40
  41 checklist = []
  42
  43
  44 class OptCheck:
  45     def __init__(self, name, expected, decision, reason):
  46         self.name = name
  47         self.expected = expected
  48         self.decision = decision
  49         self.reason = reason
  50         self.state = None
  51         self.result = None
  52
  53     def check(self):
  54         if self.expected == self.state:
  55             self.result = 'OK'
  56         elif self.state is None:
  57             if self.expected == 'is not set':
  58                 self.result = 'OK: not found'
  59             else:
  60                 self.result = 'FAIL: not found'
  61         else:
  62             self.result = 'FAIL: "' + self.state + '"'
  63
  64         if self.result.startswith('OK'):
  65             return True, self.result
  66         else:
  67             return False, self.result
  68
  69     def __repr__(self):
  70         return '{} = {}'.format(self.name, self.state)
  71
  72
  73 class OR:
  74     def __init__(self, *opts):
  75         self.opts = opts
  76         self.result = None
  77
  78     # self.opts[0] is the option which this OR-check is about.
  79     # Use case: OR(<X_is_hardened>, <X_is_disabled>)
  80
  81     @property
  82     def name(self):
  83         return self.opts[0].name
  84
  85     @property
  86     def expected(self):
  87         return self.opts[0].expected
  88
  89     @property
  90     def state(self):
  91         return self.opts[0].state
  92
  93     @property
  94     def decision(self):
  95         return self.opts[0].decision
  96
  97     @property
  98     def reason(self):
  99         return self.opts[0].reason
 100
 101     def check(self):
 102         for i, opt in enumerate(self.opts):
 103             result, msg = opt.check()
 104             if result:
 105                 if i == 0:
 106                     self.result = opt.result
 107                 else:
 108                     self.result = 'CONFIG_{}: {} ("{}")'.format(opt.name, opt.result, opt.expected)
 109                 return True, self.result
 110         self.result = self.opts[0].result
 111         return False, self.result
 112
 113
 114 def detect_arch(fname):
 115     with open(fname, 'r') as f:
 116         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 117         arch = None
 118         msg = None
 119         print('[+] Trying to detect architecture in "{}"...'.format(fname))
 120         for line in f.readlines():
 121             if arch_pattern.match(line):
 122                 option, value = line[7:].split('=', 1)
 123                 if option in supported_archs:
 124                     if not arch:
 125                         arch = option
 126                     else:
 127                         return None, 'more than one supported architecture is detected'
 128         if not arch:
 129             return None, 'failed to detect architecture'
 130         else:
 131             return arch, 'OK'
 132
 133
 134 def construct_checklist(arch):
 135     modules_not_set = OptCheck('MODULES',                'is not set', 'kspp', 'cut_attack_surface')
 136     devmem_not_set = OptCheck('DEVMEM',                  'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
 137
 138     checklist.append(OptCheck('BUG',                         'y', 'defconfig', 'self_protection'))
 139     checklist.append(OptCheck('RETPOLINE',                   'y', 'defconfig', 'self_protection'))
 140     checklist.append(OptCheck('X86_SMAP',                    'y', 'defconfig', 'self_protection'))
 141     checklist.append(OptCheck('X86_INTEL_UMIP',              'y', 'defconfig', 'self_protection'))
 142     checklist.append(OR(OptCheck('STRICT_KERNEL_RWX',        'y', 'defconfig', 'self_protection'), \
 143                         OptCheck('DEBUG_RODATA',             'y', 'defconfig', 'self_protection'))) # before v4.11
 144     checklist.append(OptCheck('RANDOMIZE_BASE',              'y', 'defconfig', 'self_protection'))
 145     checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG',    'y', 'defconfig', 'self_protection'), \
 146                         OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
 147     checklist.append(OptCheck('THREAD_INFO_IN_TASK',         'y', 'defconfig', 'self_protection'))
 148     checklist.append(OptCheck('SLUB_DEBUG',                  'y', 'defconfig', 'self_protection'))
 149     checklist.append(OR(OptCheck('STRICT_MODULE_RWX',        'y', 'defconfig', 'self_protection'), \
 150                         OptCheck('DEBUG_SET_MODULE_RONX',    'y', 'defconfig', 'self_protection'), \
 151                         modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
 152     checklist.append(OptCheck('SYN_COOKIES',                 'y', 'defconfig', 'self_protection')) # another reason?
 153     if arch == 'X86_64':
 154         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',    'y', 'defconfig', 'self_protection'))
 155         checklist.append(OptCheck('RANDOMIZE_MEMORY',        'y', 'defconfig', 'self_protection'))
 156         checklist.append(OptCheck('VMAP_STACK',              'y', 'defconfig', 'self_protection'))
 157
 158     checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'))
 159     checklist.append(OptCheck('DEBUG_WX',                         'y', 'kspp', 'self_protection'))
 160     checklist.append(OptCheck('SCHED_STACK_END_CHECK',            'y', 'kspp', 'self_protection'))
 161     checklist.append(OptCheck('PAGE_POISONING',                   'y', 'kspp', 'self_protection'))
 162     checklist.append(OptCheck('SLAB_FREELIST_HARDENED',           'y', 'kspp', 'self_protection'))
 163     checklist.append(OptCheck('SLAB_FREELIST_RANDOM',             'y', 'kspp', 'self_protection'))
 164     checklist.append(OptCheck('HARDENED_USERCOPY',                'y', 'kspp', 'self_protection'))
 165     checklist.append(OptCheck('HARDENED_USERCOPY_FALLBACK',       'is not set', 'kspp', 'self_protection'))
 166     checklist.append(OptCheck('FORTIFY_SOURCE',                   'y', 'kspp', 'self_protection'))
 167     checklist.append(OptCheck('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'))
 168     checklist.append(OptCheck('GCC_PLUGIN_RANDSTRUCT',            'y', 'kspp', 'self_protection'))
 169     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK',            'y', 'kspp', 'self_protection'))
 170     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL',  'y', 'kspp', 'self_protection'))
 171     checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'))
 172     checklist.append(OptCheck('REFCOUNT_FULL',                    'y', 'kspp', 'self_protection'))
 173     checklist.append(OptCheck('DEBUG_LIST',                       'y', 'kspp', 'self_protection'))
 174     checklist.append(OptCheck('DEBUG_SG',                         'y', 'kspp', 'self_protection'))
 175     checklist.append(OptCheck('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'))
 176     checklist.append(OptCheck('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'))
 177     checklist.append(OR(OptCheck('MODULE_SIG',                    'y', 'kspp', 'self_protection'), \
 178                         modules_not_set))
 179     checklist.append(OR(OptCheck('MODULE_SIG_ALL',                'y', 'kspp', 'self_protection'), \
 180                         modules_not_set))
 181     checklist.append(OR(OptCheck('MODULE_SIG_SHA512',             'y', 'kspp', 'self_protection'), \
 182                         modules_not_set))
 183     checklist.append(OptCheck('MODULE_SIG_FORCE',                 'y', 'kspp', 'self_protection')) # refers to LOCK_DOWN_KERNEL
 184     checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',            '65536', 'kspp', 'self_protection'))
 185     if arch == 'X86_32':
 186         checklist.append(OptCheck('HIGHMEM64G',                   'y', 'kspp', 'self_protection'))
 187         checklist.append(OptCheck('X86_PAE',                      'y', 'kspp', 'self_protection'))
 188
 189     checklist.append(OptCheck('GCC_PLUGIN_STACKLEAK',             'y', 'my', 'self_protection'))
 190     checklist.append(OptCheck('LOCK_DOWN_KERNEL',                 'y', 'my', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
 191     checklist.append(OptCheck('SLUB_DEBUG_ON',                    'y', 'my', 'self_protection'))
 192     checklist.append(OptCheck('SECURITY_DMESG_RESTRICT',          'y', 'my', 'self_protection'))
 193     checklist.append(OptCheck('STATIC_USERMODEHELPER',            'y', 'my', 'self_protection')) # breaks systemd?
 194     checklist.append(OptCheck('SECURITY_LOADPIN',                 'y', 'my', 'self_protection'))
 195     checklist.append(OptCheck('PAGE_POISONING_NO_SANITY',         'is not set', 'my', 'self_protection'))
 196     checklist.append(OptCheck('PAGE_POISONING_ZERO',              'is not set', 'my', 'self_protection'))
 197     checklist.append(OptCheck('SLAB_MERGE_DEFAULT',               'is not set', 'my', 'self_protection')) # slab_nomerge
 198     if arch == 'X86_32':
 199         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',         'y', 'my', 'self_protection'))
 200
 201     checklist.append(OptCheck('SECURITY',                    'y', 'defconfig', 'security_policy'))
 202     checklist.append(OptCheck('SECURITY_YAMA',               'y', 'kspp', 'security_policy'))
 203     checklist.append(OptCheck('SECURITY_SELINUX_DISABLE',    'is not set', 'kspp', 'security_policy'))
 204
 205     checklist.append(OptCheck('SECCOMP',              'y', 'defconfig', 'cut_attack_surface'))
 206     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'defconfig', 'cut_attack_surface'))
 207     checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'defconfig', 'cut_attack_surface'), \
 208                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 209
 210     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 211                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 212     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 213     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'kspp', 'cut_attack_surface'))
 214     checklist.append(OptCheck('DEVKMEM',              'is not set', 'kspp', 'cut_attack_surface'))
 215     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'kspp', 'cut_attack_surface'))
 216     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 217     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 218     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 219     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 220     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 221     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 222     if arch == 'X86_64':
 223         checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 224         checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 225         checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 226         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 227
 228     checklist.append(OptCheck('X86_PTDUMP',              'is not set', 'grsecurity', 'cut_attack_surface'))
 229     checklist.append(OptCheck('ZSMALLOC_STAT',           'is not set', 'grsecurity', 'cut_attack_surface'))
 230     checklist.append(OptCheck('PAGE_OWNER',              'is not set', 'grsecurity', 'cut_attack_surface'))
 231     checklist.append(OptCheck('DEBUG_KMEMLEAK',          'is not set', 'grsecurity', 'cut_attack_surface'))
 232     checklist.append(OptCheck('BINFMT_AOUT',             'is not set', 'grsecurity', 'cut_attack_surface'))
 233     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 234     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 235     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 236     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 237     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 238     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 239     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 240     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 241     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 242     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 243     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 244     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 245     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 246
 247     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 248     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 249     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 250     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 251     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 252
 253     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 254     checklist.append(OptCheck('KEXEC_FILE',           'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 255     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 256     checklist.append(OptCheck('USER_NS',              'is not set', 'my', 'cut_attack_surface')) # user.max_user_namespaces=0
 257     checklist.append(OptCheck('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'))
 258     checklist.append(OptCheck('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'))
 259     checklist.append(OptCheck('FTRACE',               'is not set', 'my', 'cut_attack_surface'))
 260     checklist.append(OptCheck('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'))
 261     if arch == 'X86_32':
 262         checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
 263
 264     if arch == 'X86_64':
 265         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '32', 'my', 'userspace_protection'))
 266     if arch == 'X86_32':
 267         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '16', 'my', 'userspace_protection'))
 268
 269 #   checklist.append(OptCheck('LKDTM',    'm', 'my', 'feature_test'))
 270
 271
 272 def print_checklist(arch):
 273     print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 274     print('  {:<39}|{:^13}|{:^10}|{:^20}'.format(
 275         'option name', 'desired val', 'decision', 'reason'))
 276     print('  ' + '=' * 86)
 277     for opt in checklist:
 278         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}'.format(
 279             opt.name, opt.expected, opt.decision, opt.reason))
 280     print()
 281
 282
 283 def print_check_results():
 284     print('  {:<39}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
 285         'option name', 'desired val', 'decision', 'reason', 'check result'))
 286     print('  ' + '=' * 115)
 287     for opt in checklist:
 288         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
 289             opt.name, opt.expected, opt.decision, opt.reason, opt.result))
 290     print()
 291
 292
 293 def get_option_state(options, name):
 294     return options.get(name, None)
 295
 296
 297 def perform_checks(parsed_options):
 298     for opt in checklist:
 299         if hasattr(opt, 'opts'):
 300             for o in opt.opts:
 301                 o.state = get_option_state(parsed_options, o.name)
 302         else:
 303             opt.state = get_option_state(parsed_options, opt.name)
 304         opt.check()
 305
 306
 307 def check_config_file(fname):
 308     with open(fname, 'r') as f:
 309         parsed_options = OrderedDict()
 310         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 311         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 312
 313         print('[+] Checking "{}" against hardening preferences...'.format(fname))
 314         for line in f.readlines():
 315             line = line.strip()
 316             option = None
 317             value = None
 318
 319             if opt_is_on.match(line):
 320                 option, value = line[7:].split('=', 1)
 321             elif opt_is_off.match(line):
 322                 option, value = line[9:].split(' ', 1)
 323                 if value != 'is not set':
 324                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 325
 326             if option in parsed_options:
 327                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 328
 329             if option is not None:
 330                 parsed_options[option] = value
 331
 332         perform_checks(parsed_options)
 333
 334         if debug_mode:
 335             known_options = [opt.name for opt in checklist]
 336             for option, value in parsed_options.items():
 337                 if option not in known_options:
 338                     print("DEBUG: dunno about option {} ({})".format(option, value))
 339
 340         print_check_results()
 341
 342
 343 if __name__ == '__main__':
 344     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 345     parser.add_argument('-p', '--print', choices=supported_archs,
 346                         help='print hardening preferences for selected architecture')
 347     parser.add_argument('-c', '--config',
 348                         help='check the config_file against these preferences')
 349     parser.add_argument('--debug', action='store_true',
 350                         help='enable internal debug mode')
 351     args = parser.parse_args()
 352
 353     if args.debug:
 354         debug_mode = True
 355
 356     if args.config:
 357         arch, msg = detect_arch(args.config)
 358         if not arch:
 359             sys.exit('[!] ERROR: {}'.format(msg))
 360         else:
 361             print('[+] Detected architecture: {}'.format(arch))
 362
 363         construct_checklist(arch)
 364         check_config_file(args.config)
 365         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 366         if error_count == 0:
 367             print('[+] config check is PASSED')
 368             sys.exit(0)
 369         else:
 370             sys.exit('[-] config check is NOT PASSED: {} errors'.format(error_count))
 371
 372     if args.print:
 373         arch = args.print
 374         construct_checklist(arch)
 375         print_checklist(arch)
 376         sys.exit(0)
 377
 378     parser.print_help()