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