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=P
  15 #    slab_nomerge
  16 #    pti=on
  17 #    kernel.kptr_restrict=1
  18
  19 import sys
  20 from collections import namedtuple
  21 from argparse import ArgumentParser
  22 import re
  23
  24 debug_mode = False  # set it to True to print the unknown options from the config
  25 error_count = 0
  26 opt_list = []
  27
  28 Opt = namedtuple('Opt', ['name', 'state', 'decision', 'reason'])
  29
  30 def construct_opt_list():
  31     opt_list.append([Opt('BUG',                     'y', 'ubuntu18', 'self_protection'), ''])
  32     opt_list.append([Opt('PAGE_TABLE_ISOLATION',    'y', 'ubuntu18', 'self_protection'), ''])
  33     opt_list.append([Opt('RETPOLINE',               'y', 'ubuntu18', 'self_protection'), ''])
  34     opt_list.append([Opt('X86_64',                  'y', 'ubuntu18', 'self_protection'), ''])
  35     opt_list.append([Opt('STRICT_KERNEL_RWX',       'y', 'ubuntu18', 'self_protection'), ''])
  36     opt_list.append([Opt('STRICT_MODULE_RWX',       'y', 'ubuntu18', 'self_protection'), ''])
  37     opt_list.append([Opt('DEBUG_WX',                'y', 'ubuntu18', 'self_protection'), ''])
  38     opt_list.append([Opt('RANDOMIZE_BASE',          'y', 'ubuntu18', 'self_protection'), ''])
  39     opt_list.append([Opt('RANDOMIZE_MEMORY',        'y', 'ubuntu18', 'self_protection'), ''])
  40     opt_list.append([Opt('CC_STACKPROTECTOR',       'y', 'ubuntu18', 'self_protection'), ''])
  41     opt_list.append([Opt('CC_STACKPROTECTOR_STRONG','y', 'ubuntu18', 'self_protection'), ''])
  42     opt_list.append([Opt('VMAP_STACK',              'y', 'ubuntu18', 'self_protection'), ''])
  43     opt_list.append([Opt('THREAD_INFO_IN_TASK',     'y', 'ubuntu18', 'self_protection'), ''])
  44     opt_list.append([Opt('SCHED_STACK_END_CHECK',   'y', 'ubuntu18', 'self_protection'), ''])
  45     opt_list.append([Opt('SLUB_DEBUG',              'y', 'ubuntu18', 'self_protection'), ''])
  46     opt_list.append([Opt('SLAB_FREELIST_HARDENED',  'y', 'ubuntu18', 'self_protection'), ''])
  47     opt_list.append([Opt('SLAB_FREELIST_RANDOM',    'y', 'ubuntu18', 'self_protection'), ''])
  48     opt_list.append([Opt('HARDENED_USERCOPY',       'y', 'ubuntu18', 'self_protection'), ''])
  49     opt_list.append([Opt('FORTIFY_SOURCE',          'y', 'ubuntu18', 'self_protection'), ''])
  50     opt_list.append([Opt('MODULE_SIG',              'y', 'ubuntu18', 'self_protection'), ''])
  51     opt_list.append([Opt('MODULE_SIG_ALL',          'y', 'ubuntu18', 'self_protection'), ''])
  52     opt_list.append([Opt('MODULE_SIG_SHA512',       'y', 'ubuntu18', 'self_protection'), ''])
  53     opt_list.append([Opt('SYN_COOKIES',             'y', 'ubuntu18', 'self_protection'), '']) # another reason?
  54     opt_list.append([Opt('DEFAULT_MMAP_MIN_ADDR',   '65536', 'ubuntu18', 'self_protection'), ''])
  55
  56     opt_list.append([Opt('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'), ''])
  57     opt_list.append([Opt('PAGE_POISONING',                   'y', 'kspp', 'self_protection'), ''])
  58     opt_list.append([Opt('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'), ''])
  59     opt_list.append([Opt('GCC_PLUGIN_RANDSTRUCT',            'y', 'kspp', 'self_protection'), ''])
  60     opt_list.append([Opt('GCC_PLUGIN_STRUCTLEAK',            'y', 'kspp', 'self_protection'), ''])
  61     opt_list.append([Opt('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL',  'y', 'kspp', 'self_protection'), ''])
  62     opt_list.append([Opt('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'), ''])
  63     opt_list.append([Opt('REFCOUNT_FULL',                    'y', 'kspp', 'self_protection'), ''])
  64     opt_list.append([Opt('DEBUG_LIST',                       'y', 'kspp', 'self_protection'), ''])
  65     opt_list.append([Opt('DEBUG_SG',                         'y', 'kspp', 'self_protection'), ''])
  66     opt_list.append([Opt('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'), ''])
  67     opt_list.append([Opt('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'), ''])
  68     opt_list.append([Opt('MODULE_SIG_FORCE',                 'y', 'kspp', 'self_protection'), ''])
  69     opt_list.append([Opt('HARDENED_USERCOPY_FALLBACK',       'is not set', 'kspp', 'self_protection'), ''])
  70
  71     opt_list.append([Opt('GCC_PLUGIN_STACKLEAK',             'y', 'my', 'self_protection'), ''])
  72     opt_list.append([Opt('SLUB_DEBUG_ON',                    'y', 'my', 'self_protection'), ''])
  73     opt_list.append([Opt('SECURITY_DMESG_RESTRICT',          'y', 'my', 'self_protection'), ''])
  74     opt_list.append([Opt('STATIC_USERMODEHELPER',            'y', 'my', 'self_protection'), '']) # breaks systemd?
  75     opt_list.append([Opt('PAGE_POISONING_NO_SANITY',         'is not set', 'my', 'self_protection'), ''])
  76     opt_list.append([Opt('PAGE_POISONING_ZERO',              'is not set', 'my', 'self_protection'), ''])
  77
  78     opt_list.append([Opt('SECURITY',                    'y', 'ubuntu18', 'security_policy'), ''])
  79     opt_list.append([Opt('SECURITY_YAMA',               'y', 'ubuntu18', 'security_policy'), ''])
  80     opt_list.append([Opt('SECURITY_SELINUX_DISABLE',    'is not set', 'ubuntu18', 'security_policy'), ''])
  81
  82     opt_list.append([Opt('SECCOMP',              'y', 'ubuntu18', 'cut_attack_surface'), ''])
  83     opt_list.append([Opt('SECCOMP_FILTER',       'y', 'ubuntu18', 'cut_attack_surface'), ''])
  84     opt_list.append([Opt('STRICT_DEVMEM',        'y', 'ubuntu18', 'cut_attack_surface'), ''])
  85     opt_list.append([Opt('ACPI_CUSTOM_METHOD',   'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  86     opt_list.append([Opt('COMPAT_BRK',           'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  87     opt_list.append([Opt('DEVKMEM',              'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  88     opt_list.append([Opt('COMPAT_VDSO',          'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  89     opt_list.append([Opt('X86_PTDUMP',           'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  90     opt_list.append([Opt('ZSMALLOC_STAT',        'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  91     opt_list.append([Opt('PAGE_OWNER',           'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  92     opt_list.append([Opt('DEBUG_KMEMLEAK',       'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  93
  94     opt_list.append([Opt('IO_STRICT_DEVMEM',     'y', 'kspp', 'cut_attack_surface'), ''])
  95     opt_list.append([Opt('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface'), '']) # 'vsyscall=none'
  96     opt_list.append([Opt('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'), ''])
  97     opt_list.append([Opt('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'), ''])
  98     opt_list.append([Opt('KEXEC',                'is not set', 'kspp', 'cut_attack_surface'), ''])
  99     opt_list.append([Opt('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface'), ''])
 100     opt_list.append([Opt('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'), ''])
 101     opt_list.append([Opt('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'), ''])
 102     opt_list.append([Opt('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'), ''])
 103     opt_list.append([Opt('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'), ''])
 104     opt_list.append([Opt('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface'), ''])
 105
 106     opt_list.append([Opt('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 107     opt_list.append([Opt('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 108     opt_list.append([Opt('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 109     opt_list.append([Opt('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 110     opt_list.append([Opt('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 111     opt_list.append([Opt('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 112     opt_list.append([Opt('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 113     opt_list.append([Opt('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 114     opt_list.append([Opt('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 115     opt_list.append([Opt('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 116     opt_list.append([Opt('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 117     opt_list.append([Opt('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 118     opt_list.append([Opt('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'), ''])
 119
 120     opt_list.append([Opt('KEXEC_FILE',           'is not set', 'my', 'cut_attack_surface'), ''])
 121     opt_list.append([Opt('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'), ''])
 122     opt_list.append([Opt('USER_NS',              'is not set', 'my', 'cut_attack_surface'), '']) # user.max_user_namespaces=0
 123     opt_list.append([Opt('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'), ''])
 124     opt_list.append([Opt('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'), ''])
 125     opt_list.append([Opt('FTRACE',               'is not set', 'my', 'cut_attack_surface'), ''])
 126     opt_list.append([Opt('PROFILING',            'is not set', 'my', 'cut_attack_surface'), ''])
 127     opt_list.append([Opt('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'), ''])
 128     opt_list.append([Opt('BPF_SYSCALL',          'is not set', 'my', 'cut_attack_surface'), ''])
 129
 130     opt_list.append([Opt('ARCH_MMAP_RND_BITS',   '32', 'my', 'userspace_protection'), ''])
 131
 132     opt_list.append([Opt('LKDTM',    'm', 'my', 'feature_test'), ''])
 133
 134
 135 def print_opt_list():
 136     print('[+] Printing kernel hardening preferences...')
 137     print('  {:<39}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'))
 138     print('  ======================================================================================')
 139     for o in opt_list:
 140         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}'.format(o[0].name, o[0].state, o[0].decision, o[0].reason))
 141     print()
 142
 143
 144 def print_check_results():
 145     global error_count
 146
 147     print('  {:<39}|{:^13}|{:^10}|{:^20}||{:^20}'.format('option name', 'desired val', 'decision', 'reason', 'check result'))
 148     print('  ===========================================================================================================')
 149     for o in opt_list:
 150         if o[1] == '':
 151             if o[0].state == 'is not set':
 152                 o[1] = 'OK: not found'
 153             else:
 154                 error_count += 1
 155                 o[1] = 'FAIL: not found'
 156         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}||{:^20}'.format(o[0].name, o[0].state, o[0].decision, o[0].reason, o[1]))
 157     print()
 158
 159
 160 def check_state(option):
 161     global error_count
 162     found = False
 163
 164     for o in opt_list:
 165         if option[0] == o[0].name:
 166             found = True
 167
 168             if o[1] != '':
 169                 sys.exit('[!] BUG: CONFIG_{} was found more than once'.format(o[0].name))
 170
 171             if option[1] == o[0].state:
 172                 o[1] = 'OK'
 173             else:
 174                 o[1] = 'FAIL: "' + option[1] + '"'
 175                 error_count += 1
 176
 177     if not found and debug_mode:
 178         print("DEBUG: dunno about option {} ".format(option))
 179
 180
 181 def check_on(line):
 182     if line[:7] != 'CONFIG_':
 183         sys.exit('[!] BUG: bad enabled config option "{}"'.format(line))
 184
 185     line_parts = line[7:].split('=')
 186     check_state(line_parts)
 187
 188
 189 def check_off(line):
 190     if line[:9] != '# CONFIG_':
 191         sys.exit('[!] BUG: bad disabled config option "{}"'.format(line))
 192
 193     line_parts = line[9:].split(' ', 1)
 194
 195     if line_parts[1] != 'is not set':
 196         sys.exit('[!] BUG: bad disabled config option "{}"'.format(line))
 197
 198     check_state(line_parts)
 199
 200
 201 def check_config_file(fname):
 202     f = open(fname, 'r')
 203
 204     print('[+] Checking "{}" against hardening preferences...'.format(fname))
 205     for line in f:
 206         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 207         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 208         if opt_is_on.match(line):
 209             check_on(line[:-1]) # drop newline
 210         if opt_is_off.match(line):
 211             check_off(line[:-1]) # ditto
 212
 213     print_check_results()
 214     f.close()
 215
 216
 217 if __name__ == '__main__':
 218     parser = ArgumentParser(description='Kconfig hardened check')
 219     parser.add_argument('-p', '--print', default=False, action='store_true', help='print hardening preferences')
 220     parser.add_argument('-c', '--config', help='check the config_file against these preferences')
 221     parser.add_argument('--debug', default=False, action='store_true', help='enable internal debug mode')
 222     args = parser.parse_args()
 223
 224     construct_opt_list()
 225
 226     if args.print:
 227         print_opt_list()
 228         sys.exit(0)
 229
 230     if args.debug:
 231         debug_mode = True
 232
 233     if args.config:
 234         check_config_file(args.config)
 235         if error_count == 0:
 236             print('[+] config check is PASSED')
 237             sys.exit(0)
 238         else:
 239             sys.exit('[-] config check is NOT PASSED: {} errors'.format(error_count))
 240
 241     parser.print_help()