kconfig_hardened_check/__init__.py

   1 #!/usr/bin/python3
   2
   3 #
   4 # This tool helps me to check Linux kernel options against
   5 # my security 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 #    slab_nomerge
  15 #    page_alloc.shuffle=1
  16 #    iommu=force (does it help against DMA attacks?)
  17 #    slub_debug=FZ (slow)
  18 #    init_on_alloc=1 (since v5.3)
  19 #    init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
  20 #    loadpin.enforce=1
  21 #    debugfs=no-mount (or off if possible)
  22 #    randomize_kstack_offset=1
  23 #
  24 #    Mitigations of CPU vulnerabilities:
  25 #       Аrch-independent:
  26 #           mitigations=auto,nosmt (nosmt is slow)
  27 #       X86:
  28 #           spectre_v2=on
  29 #           pti=on
  30 #           spec_store_bypass_disable=on
  31 #           l1tf=full,force
  32 #           mds=full,nosmt
  33 #           tsx=off
  34 #           l1d_flush=on
  35 #       ARM64:
  36 #           kpti=on
  37 #           ssbd=force-on
  38 #
  39 #    Should NOT be set:
  40 #           nokaslr
  41 #           arm64.nobti
  42 #           arm64.nopauth
  43 #
  44 #    Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
  45 #           kasan=on
  46 #           kasan.stacktrace=off
  47 #           kasan.fault=panic
  48 #
  49 # N.B. Hardening sysctls:
  50 #    kernel.kptr_restrict=2 (or 1?)
  51 #    kernel.dmesg_restrict=1 (also see the kconfig option)
  52 #    kernel.perf_event_paranoid=3
  53 #    kernel.kexec_load_disabled=1
  54 #    kernel.yama.ptrace_scope=3
  55 #    user.max_user_namespaces=0
  56 #    what about bpf_jit_enable?
  57 #    kernel.unprivileged_bpf_disabled=1
  58 #    net.core.bpf_jit_harden=2
  59 #
  60 #    vm.unprivileged_userfaultfd=0
  61 #        (at first, it disabled unprivileged userfaultfd,
  62 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
  63 #
  64 #    dev.tty.ldisc_autoload=0
  65 #    fs.protected_symlinks=1
  66 #    fs.protected_hardlinks=1
  67 #    fs.protected_fifos=2
  68 #    fs.protected_regular=2
  69 #    fs.suid_dumpable=0
  70 #    kernel.modules_disabled=1
  71
  72
  73 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
  74 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
  75
  76
  77 import sys
  78 from argparse import ArgumentParser
  79 from collections import OrderedDict
  80 import re
  81 import json
  82 from .__about__ import __version__
  83
  84
  85 class OptCheck:
  86     def __init__(self, reason, decision, name, expected):
  87         self.name = name
  88         self.expected = expected
  89         self.decision = decision
  90         self.reason = reason
  91         self.state = None
  92         self.result = None
  93
  94     def check(self):
  95         if self.expected == self.state:
  96             self.result = 'OK'
  97         elif self.state is None:
  98             if self.expected == 'is not set':
  99                 self.result = 'OK: not found'
 100             else:
 101                 self.result = 'FAIL: not found'
 102         else:
 103             self.result = 'FAIL: "' + self.state + '"'
 104
 105         if self.result.startswith('OK'):
 106             return True
 107         return False
 108
 109     def table_print(self, _mode, with_results):
 110         print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, self.expected, self.decision, self.reason), end='')
 111         if with_results:
 112             print('| {}'.format(self.result), end='')
 113
 114
 115 class KconfigCheck(OptCheck):
 116     def __init__(self, *args, **kwargs):
 117         super().__init__(*args, **kwargs)
 118         self.name = 'CONFIG_' + self.name
 119
 120     @property
 121     def type(self):
 122         return 'kconfig'
 123
 124
 125 class VersionCheck:
 126     def __init__(self, ver_expected):
 127         self.ver_expected = ver_expected
 128         self.ver = ()
 129         self.result = None
 130
 131     @property
 132     def type(self):
 133         return 'version'
 134
 135     def check(self):
 136         if self.ver[0] > self.ver_expected[0]:
 137             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 138             return True
 139         if self.ver[0] < self.ver_expected[0]:
 140             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 141             return False
 142         if self.ver[1] >= self.ver_expected[1]:
 143             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 144             return True
 145         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 146         return False
 147
 148     def table_print(self, _mode, with_results):
 149         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 150         print('{:<91}'.format(ver_req), end='')
 151         if with_results:
 152             print('| {}'.format(self.result), end='')
 153
 154
 155 class PresenceCheck:
 156     def __init__(self, name, type):
 157         self.type = type
 158         if self.type == 'kconfig':
 159             self.name = 'CONFIG_' + name
 160         else:
 161             self.name = name
 162         self.state = None
 163         self.result = None
 164
 165     def check(self):
 166         if self.state is None:
 167             self.result = 'FAIL: not present'
 168             return False
 169         self.result = 'OK: is present'
 170         return True
 171
 172     def table_print(self, _mode, with_results):
 173         print('{:<91}'.format(self.name + ' is present'), end='')
 174         if with_results:
 175             print('| {}'.format(self.result), end='')
 176
 177
 178 class ComplexOptCheck:
 179     def __init__(self, *opts):
 180         self.opts = opts
 181         if not self.opts:
 182             sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
 183         if len(self.opts) == 1:
 184             sys.exit('[!] ERROR: useless {} check'.format(self.__class__.__name__))
 185         if not isinstance(opts[0], KconfigCheck):
 186             sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
 187         self.result = None
 188
 189     @property
 190     def name(self):
 191         return self.opts[0].name
 192
 193     @property
 194     def type(self):
 195         return self.opts[0].type
 196
 197     @property
 198     def expected(self):
 199         return self.opts[0].expected
 200
 201     @property
 202     def decision(self):
 203         return self.opts[0].decision
 204
 205     @property
 206     def reason(self):
 207         return self.opts[0].reason
 208
 209     def table_print(self, mode, with_results):
 210         if mode == 'verbose':
 211             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 212             if with_results:
 213                 print('| {}'.format(self.result), end='')
 214             for o in self.opts:
 215                 print()
 216                 o.table_print(mode, with_results)
 217         else:
 218             o = self.opts[0]
 219             o.table_print(mode, False)
 220             if with_results:
 221                 print('| {}'.format(self.result), end='')
 222
 223
 224 class OR(ComplexOptCheck):
 225     # self.opts[0] is the option that this OR-check is about.
 226     # Use cases:
 227     #     OR(<X_is_hardened>, <X_is_disabled>)
 228     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 229
 230     def check(self):
 231         if not self.opts:
 232             sys.exit('[!] ERROR: invalid OR check')
 233
 234         for i, opt in enumerate(self.opts):
 235             ret = opt.check()
 236             if ret:
 237                 if opt.result == 'OK' and i != 0:
 238                     # Simple OK is not enough for additional checks, add more info:
 239                     self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
 240                 else:
 241                     self.result = opt.result
 242                 return True
 243         self.result = self.opts[0].result
 244         return False
 245
 246
 247 class AND(ComplexOptCheck):
 248     # self.opts[0] is the option that this AND-check is about.
 249     # Use cases:
 250     #     AND(<suboption>, <main_option>)
 251     #       Suboption is not checked if checking of the main_option is failed.
 252     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 253
 254     def check(self):
 255         for i, opt in reversed(list(enumerate(self.opts))):
 256             ret = opt.check()
 257             if i == 0:
 258                 self.result = opt.result
 259                 return ret
 260             if not ret:
 261                 # This FAIL is caused by additional checks,
 262                 # and not by the main option that this AND-check is about.
 263                 # Describe the reason of the FAIL.
 264                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
 265                     self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
 266                 elif opt.result == 'FAIL: not present':
 267                     self.result = 'FAIL: {} not present'.format(opt.name)
 268                 else:
 269                     # This FAIL message is self-explaining.
 270                     self.result = opt.result
 271                 return False
 272
 273         sys.exit('[!] ERROR: invalid AND check')
 274
 275
 276 def detect_arch(fname, archs):
 277     with open(fname, 'r') as f:
 278         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 279         arch = None
 280         for line in f.readlines():
 281             if arch_pattern.match(line):
 282                 option, _ = line[7:].split('=', 1)
 283                 if option in archs:
 284                     if not arch:
 285                         arch = option
 286                     else:
 287                         return None, 'more than one supported architecture is detected'
 288         if not arch:
 289             return None, 'failed to detect architecture'
 290         return arch, 'OK'
 291
 292
 293 def detect_version(fname):
 294     with open(fname, 'r') as f:
 295         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 296         for line in f.readlines():
 297             if ver_pattern.match(line):
 298                 line = line.strip()
 299                 parts = line.split()
 300                 ver_str = parts[2]
 301                 ver_numbers = ver_str.split('.')
 302                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 303                     msg = 'failed to parse the version "' + ver_str + '"'
 304                     return None, msg
 305                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 306         return None, 'no kernel version detected'
 307
 308
 309 def add_kconfig_checks(l, arch):
 310     # Calling the KconfigCheck class constructor:
 311     #     KconfigCheck(reason, decision, name, expected)
 312
 313     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 314     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 315
 316     # 'self_protection', 'defconfig'
 317     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
 318     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 319     l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
 320     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 321              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 322     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 323              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 324     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
 325              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
 326              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
 327     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
 328              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
 329     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
 330     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 331     if arch in ('X86_64', 'ARM64', 'X86_32'):
 332         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 333         l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 334     if arch in ('X86_64', 'ARM64'):
 335         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 336     if arch in ('X86_64', 'X86_32'):
 337         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 338         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 339         l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
 340         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 341         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 342                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 343     if arch in ('ARM64', 'ARM'):
 344         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 345     if arch == 'X86_64':
 346         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 347         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 348         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 349                   iommu_support_is_set)]
 350         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 351                   iommu_support_is_set)]
 352     if arch == 'ARM64':
 353         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 354         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
 355         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 356         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
 357                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
 358                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
 359         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 360         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
 361         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
 362         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 363                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 364         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
 365     if arch == 'ARM':
 366         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 367         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 368
 369     # 'self_protection', 'kspp'
 370     l += [KconfigCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 371     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 372     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 373     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 374     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 375     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 376     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 377     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 378     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 379     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 380     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 381     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 382     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 383     l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
 384     randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
 385     l += [randstruct_is_set]
 386     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 387     l += [hardened_usercopy_is_set]
 388     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 389               hardened_usercopy_is_set)]
 390     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 391               hardened_usercopy_is_set)]
 392     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 393              modules_not_set)]
 394     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 395              modules_not_set)]
 396     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 397              modules_not_set)]
 398     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 399              modules_not_set)] # refers to LOCKDOWN
 400     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 401              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 402     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 403              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 404              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 405              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 406              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 407              # the 0xAA poison pattern on allocation.
 408              # That brings higher performance penalty.
 409     if arch in ('X86_64', 'ARM64', 'X86_32'):
 410         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 411         l += [stackleak_is_set]
 412         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
 413     if arch in ('X86_64', 'X86_32'):
 414         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 415     if arch in ('ARM64', 'ARM'):
 416         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 417         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 418     if arch == 'ARM64':
 419         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 420     if arch == 'X86_32':
 421         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 422         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 423         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 424
 425     # 'self_protection', 'maintainer'
 426     ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
 427     l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
 428     l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
 429               ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
 430     l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
 431               ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
 432
 433     # 'self_protection', 'clipos'
 434     l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
 435     l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 436     l += [KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y')]
 437     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
 438     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
 439     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
 440     l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 441               randstruct_is_set)]
 442     if arch in ('X86_64', 'ARM64', 'X86_32'):
 443         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
 444                   stackleak_is_set)]
 445         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 446                   stackleak_is_set)]
 447     if arch in ('X86_64', 'X86_32'):
 448         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 449                   iommu_support_is_set)]
 450     if arch == 'X86_64':
 451         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
 452                   iommu_support_is_set)]
 453     if arch == 'X86_32':
 454         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
 455                   iommu_support_is_set)]
 456
 457     # 'self_protection', 'my'
 458     l += [KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y')] # needs userspace support (systemd)
 459     if arch == 'X86_64':
 460         l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
 461                   iommu_support_is_set)]
 462     if arch == 'ARM64':
 463         l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
 464         l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
 465         cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
 466         l += [cfi_clang_is_set]
 467         l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
 468                   cfi_clang_is_set)]
 469
 470     # 'security_policy'
 471     if arch in ('X86_64', 'ARM64', 'X86_32'):
 472         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 473     if arch == 'ARM':
 474         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 475     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 476     l += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
 477              KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
 478     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 479     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 480     l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 481     l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
 482     loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
 483     l += [loadpin_is_set] # needs userspace support
 484     l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
 485               loadpin_is_set)]
 486
 487     # 'cut_attack_surface', 'defconfig'
 488     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 489     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 490     if arch in ('X86_64', 'ARM64', 'X86_32'):
 491         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 492                  devmem_not_set)] # refers to LOCKDOWN
 493
 494     # 'cut_attack_surface', 'kspp'
 495     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 496     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 497     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 498     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 499     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 500     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 501     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 502     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 503     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 504     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 505     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 506     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 507     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 508     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 509     l += [modules_not_set]
 510     l += [devmem_not_set]
 511     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 512              devmem_not_set)] # refers to LOCKDOWN
 513     if arch == 'ARM':
 514         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 515                  devmem_not_set)] # refers to LOCKDOWN
 516     if arch == 'X86_64':
 517         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 518
 519     # 'cut_attack_surface', 'grsec'
 520     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 521     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 522     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 523     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 524     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 525     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 526     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 527     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 528     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 529     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 530     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 531     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 532     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 533     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 534     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 535     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 536     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 537     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 538     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 539     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 540     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 541     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 542     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 543     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 544     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 545     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 546     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 547     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 548     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 549     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 550     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 551     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 552     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 553     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 554     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 555     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 556     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 557     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 558               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 559
 560     # 'cut_attack_surface', 'maintainer'
 561     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 562     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 563     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 564     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 565
 566     # 'cut_attack_surface', 'grapheneos'
 567     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 568
 569     # 'cut_attack_surface', 'clipos'
 570     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 571     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 572 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 573     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 574     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 575     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 576     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 577     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 578     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 579     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 580     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 581     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 582     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 583     l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 584               PresenceCheck('LDISC_AUTOLOAD', 'kconfig'))]
 585     if arch in ('X86_64', 'X86_32'):
 586         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 587
 588     # 'cut_attack_surface', 'lockdown'
 589     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 590     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set')] # refers to LOCKDOWN
 591     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 592     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 593
 594     # 'cut_attack_surface', 'my'
 595     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 596              modules_not_set)]
 597     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 598     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 599     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 600     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 601     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 602     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 603     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 604
 605     # 'harden_userspace'
 606     if arch in ('X86_64', 'ARM64', 'X86_32'):
 607         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 608     if arch == 'ARM':
 609         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 610     if arch == 'ARM64':
 611         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_MTE', 'y')]
 612     if arch in ('ARM', 'X86_32'):
 613         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 614     if arch in ('X86_64', 'ARM64'):
 615         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 616     if arch in ('X86_32', 'ARM'):
 617         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 618
 619 #   l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
 620
 621
 622 def print_unknown_options(checklist, parsed_options):
 623     known_options = []
 624
 625     for o1 in checklist:
 626         if not hasattr(o1, 'opts'):
 627             known_options.append(o1.name)
 628             continue
 629         for o2 in o1.opts:
 630             if not hasattr(o2, 'opts'):
 631                 if hasattr(o2, 'name'):
 632                     known_options.append(o2.name)
 633                 continue
 634             for o3 in o2.opts:
 635                 if hasattr(o3, 'opts'):
 636                     sys.exit('[!] ERROR: unexpected ComplexOptCheck inside {}'.format(o2.name))
 637                 if hasattr(o3, 'name'):
 638                     known_options.append(o3.name)
 639
 640     for option, value in parsed_options.items():
 641         if option not in known_options:
 642             print('[?] No check for option {} ({})'.format(option, value))
 643
 644
 645 def print_checklist(mode, checklist, with_results):
 646     if mode == 'json':
 647         opts = []
 648         for o in checklist:
 649             opt = [o.name, o.type, o.expected, o.decision, o.reason]
 650             if with_results:
 651                 opt.append(o.result)
 652             opts.append(opt)
 653         print(json.dumps(opts))
 654         return
 655
 656     # table header
 657     sep_line_len = 91
 658     if with_results:
 659         sep_line_len += 30
 660     print('=' * sep_line_len)
 661     print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
 662     if with_results:
 663         print('| {}'.format('check result'), end='')
 664     print()
 665     print('=' * sep_line_len)
 666
 667     # table contents
 668     for opt in checklist:
 669         if with_results:
 670             if mode == 'show_ok':
 671                 if not opt.result.startswith('OK'):
 672                     continue
 673             if mode == 'show_fail':
 674                 if not opt.result.startswith('FAIL'):
 675                     continue
 676         opt.table_print(mode, with_results)
 677         print()
 678         if mode == 'verbose':
 679             print('-' * sep_line_len)
 680     print()
 681
 682     # final score
 683     if with_results:
 684         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 685         fail_suppressed = ''
 686         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 687         ok_suppressed = ''
 688         if mode == 'show_ok':
 689             fail_suppressed = ' (suppressed in output)'
 690         if mode == 'show_fail':
 691             ok_suppressed = ' (suppressed in output)'
 692         if mode != 'json':
 693             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 694
 695
 696 def populate_opt_with_data(opt, parsed_options, kernel_version):
 697     if hasattr(opt, 'opts'):
 698         # prepare ComplexOptCheck
 699         for o in opt.opts:
 700             if hasattr(o, 'opts'):
 701                 # Recursion for nested ComplexOptChecks
 702                 populate_opt_with_data(o, parsed_options, kernel_version)
 703             if hasattr(o, 'state'):
 704                 o.state = parsed_options.get(o.name, None)
 705             if hasattr(o, 'ver'):
 706                 o.ver = kernel_version
 707     else:
 708         # prepare simple check, opt.state is mandatory
 709         if not hasattr(opt, 'state'):
 710             sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
 711         opt.state = parsed_options.get(opt.name, None)
 712
 713
 714 def populate_with_data(checklist, parsed_options, kernel_version):
 715     for opt in checklist:
 716         populate_opt_with_data(opt, parsed_options, kernel_version)
 717
 718
 719 def perform_checks(checklist):
 720     for opt in checklist:
 721         opt.check()
 722
 723
 724 def parse_kconfig_file(parsed_options, fname):
 725     with open(fname, 'r') as f:
 726         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 727         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 728
 729         for line in f.readlines():
 730             line = line.strip()
 731             option = None
 732             value = None
 733
 734             if opt_is_on.match(line):
 735                 option, value = line.split('=', 1)
 736             elif opt_is_off.match(line):
 737                 option, value = line[2:].split(' ', 1)
 738                 if value != 'is not set':
 739                     sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
 740
 741             if option in parsed_options:
 742                 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
 743
 744             if option:
 745                 parsed_options[option] = value
 746
 747         return parsed_options
 748
 749
 750 def main():
 751     # Report modes:
 752     #   * verbose mode for
 753     #     - reporting about unknown kernel options in the kconfig
 754     #     - verbose printing of ComplexOptCheck items
 755     #   * json mode for printing the results in JSON format
 756     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
 757     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
 758     parser = ArgumentParser(prog='kconfig-hardened-check',
 759                             description='A tool for checking the security hardening options of the Linux kernel')
 760     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 761     parser.add_argument('-p', '--print', choices=supported_archs,
 762                         help='print security hardening preferences for the selected architecture')
 763     parser.add_argument('-c', '--config',
 764                         help='check the kernel kconfig file against these preferences')
 765     parser.add_argument('-m', '--mode', choices=report_modes,
 766                         help='choose the report mode')
 767     args = parser.parse_args()
 768
 769     mode = None
 770     if args.mode:
 771         mode = args.mode
 772         if mode != 'json':
 773             print('[+] Special report mode: {}'.format(mode))
 774
 775     config_checklist = []
 776
 777     if args.config:
 778         if mode != 'json':
 779             print('[+] Kconfig file to check: {}'.format(args.config))
 780
 781         arch, msg = detect_arch(args.config, supported_archs)
 782         if not arch:
 783             sys.exit('[!] ERROR: {}'.format(msg))
 784         if mode != 'json':
 785             print('[+] Detected architecture: {}'.format(arch))
 786
 787         kernel_version, msg = detect_version(args.config)
 788         if not kernel_version:
 789             sys.exit('[!] ERROR: {}'.format(msg))
 790         if mode != 'json':
 791             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 792
 793         # add relevant kconfig checks to the checklist
 794         add_kconfig_checks(config_checklist, arch)
 795
 796         # populate the checklist with the parsed kconfig data
 797         parsed_kconfig_options = OrderedDict()
 798         parse_kconfig_file(parsed_kconfig_options, args.config)
 799         populate_with_data(config_checklist, parsed_kconfig_options, kernel_version)
 800
 801         # now everything is ready for performing the checks
 802         perform_checks(config_checklist)
 803
 804         # finally print the results
 805         if mode == 'verbose':
 806             print_unknown_options(config_checklist, parsed_kconfig_options)
 807         print_checklist(mode, config_checklist, True)
 808
 809         sys.exit(0)
 810
 811     if args.print:
 812         if mode in ('show_ok', 'show_fail'):
 813             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
 814         arch = args.print
 815         add_kconfig_checks(config_checklist, arch)
 816         if mode != 'json':
 817             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
 818         print_checklist(mode, config_checklist, False)
 819         sys.exit(0)
 820
 821     parser.print_help()
 822     sys.exit(0)
 823
 824 if __name__ == '__main__':
 825     main()