kernel_hardening_checker/checks.py

   1 #!/usr/bin/env python3
   2
   3 """
   4 This tool is for checking the security hardening options of the Linux kernel.
   5
   6 Author: Alexander Popov <alex.popov@linux.com>
   7
   8 This module contains knowledge for checks.
   9 """
  10
  11 # pylint: disable=missing-function-docstring,line-too-long,invalid-name
  12 # pylint: disable=too-many-branches,too-many-statements
  13
  14 from .engine import KconfigCheck, CmdlineCheck, SysctlCheck, VersionCheck, OR, AND
  15
  16
  17 def add_kconfig_checks(l, arch):
  18     assert(arch), 'empty arch'
  19
  20     # Calling the KconfigCheck class constructor:
  21     #     KconfigCheck(reason, decision, name, expected)
  22     #
  23     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
  24     #     when the tool doesn't check the cmdline.
  25
  26     efi_not_set = KconfigCheck('-', '-', 'EFI', 'is not set')
  27     cc_is_gcc = KconfigCheck('-', '-', 'CC_IS_GCC', 'y') # exists since v4.18
  28     cc_is_clang = KconfigCheck('-', '-', 'CC_IS_CLANG', 'y') # exists since v4.18
  29
  30     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set') # radical, but may be useful in some cases
  31     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
  32     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
  33
  34     # 'self_protection', 'defconfig'
  35     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
  36     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
  37     l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
  38     gcc_plugins_support_is_set = KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')
  39     l += [gcc_plugins_support_is_set]
  40     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
  41     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
  42     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
  43              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'),
  44              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_REGULAR', 'y'),
  45              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_AUTO', 'y'),
  46              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
  47     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
  48              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
  49     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
  50              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
  51     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
  52              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
  53              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
  54     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
  55              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
  56     if arch in ('X86_64', 'ARM64', 'X86_32'):
  57         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
  58     if arch in ('X86_64', 'ARM64', 'ARM'):
  59         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
  60     if arch in ('X86_64', 'X86_32'):
  61         l += [KconfigCheck('self_protection', 'defconfig', 'DEBUG_WX', 'y')]
  62         l += [KconfigCheck('self_protection', 'defconfig', 'WERROR', 'y')]
  63         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE', 'y')]
  64         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_INTEL', 'y')]
  65         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_AMD', 'y')]
  66         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
  67         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
  68         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
  69         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y'),
  70                  VersionCheck((5, 19)))] # X86_SMAP is enabled by default since v5.19
  71         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
  72                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
  73     if arch in ('ARM64', 'ARM'):
  74         l += [KconfigCheck('self_protection', 'defconfig', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
  75         l += [KconfigCheck('self_protection', 'defconfig', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
  76         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
  77     if arch == 'X86_64':
  78         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
  79         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
  80         l += [KconfigCheck('self_protection', 'defconfig', 'X86_KERNEL_IBT', 'y')]
  81         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
  82                   iommu_support_is_set)]
  83         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
  84                   iommu_support_is_set)]
  85     if arch == 'ARM64':
  86         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
  87         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
  88         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
  89         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_E0PD', 'y')]
  90         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
  91         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
  92         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
  93         l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
  94         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
  95         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
  96         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
  97                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
  98                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
  99         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 100                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 101     if arch == 'ARM':
 102         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 103         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 104         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
 105         l += [KconfigCheck('self_protection', 'defconfig', 'DEBUG_ALIGN_RODATA', 'y')]
 106
 107     # 'self_protection', 'kspp'
 108     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 109     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 110     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 111     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 112     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 113     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 114     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 115     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_VIRTUAL', 'y')]
 116     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 117     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 118     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 119     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 120     l += [KconfigCheck('self_protection', 'kspp', 'HW_RANDOM_TPM', 'y')]
 121     l += [KconfigCheck('self_protection', 'kspp', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 122     kfence_is_set = KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')
 123     l += [kfence_is_set]
 124     l += [AND(KconfigCheck('self_protection', 'my', 'KFENCE_SAMPLE_INTERVAL', 'is not off'),
 125               kfence_is_set)]
 126     randstruct_is_set = OR(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_FULL', 'y'),
 127                            KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y'))
 128     l += [randstruct_is_set]
 129     l += [AND(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_PERFORMANCE', 'is not set'),
 130               KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 131               randstruct_is_set)]
 132     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 133     l += [hardened_usercopy_is_set]
 134     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 135               hardened_usercopy_is_set)] # usercopy whitelist violations should be prohibited
 136     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 137               hardened_usercopy_is_set)] # this debugging for HARDENED_USERCOPY is not needed for security
 138     l += [AND(KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y'),
 139               gcc_plugins_support_is_set)]
 140     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 141              modules_not_set)]
 142     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 143              modules_not_set)]
 144     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 145              modules_not_set)]
 146     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 147              modules_not_set)] # refers to LOCKDOWN
 148     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 149              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 150     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 151              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 152              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 153              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 154              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 155              # the 0xAA poison pattern on allocation.
 156              # That brings higher performance penalty.
 157     l += [OR(KconfigCheck('self_protection', 'kspp', 'EFI_DISABLE_PCI_DMA', 'y'),
 158              efi_not_set)]
 159     l += [OR(KconfigCheck('self_protection', 'kspp', 'RESET_ATTACK_MITIGATION', 'y'),
 160              efi_not_set)] # needs userspace support (systemd)
 161     ubsan_bounds_is_set = KconfigCheck('self_protection', 'kspp', 'UBSAN_BOUNDS', 'y')
 162     l += [ubsan_bounds_is_set]
 163     l += [OR(KconfigCheck('self_protection', 'kspp', 'UBSAN_LOCAL_BOUNDS', 'y'),
 164              AND(ubsan_bounds_is_set,
 165                  cc_is_gcc))]
 166     l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_TRAP', 'y'),
 167               ubsan_bounds_is_set,
 168               KconfigCheck('self_protection', 'kspp', 'UBSAN_SHIFT', 'is not set'),
 169               KconfigCheck('self_protection', 'kspp', 'UBSAN_DIV_ZERO', 'is not set'),
 170               KconfigCheck('self_protection', 'kspp', 'UBSAN_UNREACHABLE', 'is not set'),
 171               KconfigCheck('self_protection', 'kspp', 'UBSAN_BOOL', 'is not set'),
 172               KconfigCheck('self_protection', 'kspp', 'UBSAN_ENUM', 'is not set'),
 173               KconfigCheck('self_protection', 'kspp', 'UBSAN_ALIGNMENT', 'is not set'))] # only array index bounds checking with traps
 174     if arch in ('X86_64', 'ARM64', 'X86_32'):
 175         l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_SANITIZE_ALL', 'y'),
 176                   ubsan_bounds_is_set)] # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
 177         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 178         l += [AND(stackleak_is_set, gcc_plugins_support_is_set)]
 179         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_METRICS', 'is not set'),
 180                   stackleak_is_set,
 181                   gcc_plugins_support_is_set)]
 182         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 183                   stackleak_is_set,
 184                   gcc_plugins_support_is_set)]
 185         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
 186     if arch in ('X86_64', 'ARM64'):
 187         cfi_clang_is_set = KconfigCheck('self_protection', 'kspp', 'CFI_CLANG', 'y')
 188         l += [cfi_clang_is_set]
 189         l += [AND(KconfigCheck('self_protection', 'kspp', 'CFI_PERMISSIVE', 'is not set'),
 190                   cfi_clang_is_set)]
 191     if arch in ('X86_64', 'X86_32'):
 192         l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
 193         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 194         l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
 195         l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
 196         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 197                   iommu_support_is_set)]
 198     if arch in ('ARM64', 'ARM'):
 199         l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 200         l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
 201         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 202         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 203     if arch == 'X86_64':
 204         l += [KconfigCheck('self_protection', 'kspp', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
 205         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_SVM', 'y'),
 206                   iommu_support_is_set)]
 207         l += [AND(KconfigCheck('self_protection', 'kspp', 'AMD_IOMMU_V2', 'y'),
 208                   iommu_support_is_set)]
 209     if arch == 'ARM64':
 210         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 211         l += [KconfigCheck('self_protection', 'kspp', 'SHADOW_CALL_STACK', 'y')]
 212         l += [KconfigCheck('self_protection', 'kspp', 'KASAN_HW_TAGS', 'y')] # see also: kasan=on, kasan.stacktrace=off, kasan.fault=panic
 213     if arch == 'X86_32':
 214         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 215         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 216         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 217         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU', 'y'),
 218                   iommu_support_is_set)]
 219
 220     # 'self_protection', 'clipos'
 221     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
 222
 223     # 'security_policy'
 224     if arch in ('X86_64', 'ARM64', 'X86_32'):
 225         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')]
 226     if arch == 'ARM':
 227         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')]
 228     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 229     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LANDLOCK', 'y')]
 230     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
 231     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_BOOTPARAM', 'is not set')]
 232     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DEVELOP', 'is not set')]
 233     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM', 'y')]
 234     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 235     l += [KconfigCheck('security_policy', 'kspp', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 236     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
 237     l += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_SELINUX', 'y'),
 238              KconfigCheck('security_policy', 'my', 'SECURITY_APPARMOR', 'y'),
 239              KconfigCheck('security_policy', 'my', 'SECURITY_SMACK', 'y'),
 240              KconfigCheck('security_policy', 'my', 'SECURITY_TOMOYO', 'y'))] # one of major LSMs implementing MAC
 241
 242     # 'cut_attack_surface', 'defconfig'
 243     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 244     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 245     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
 246              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
 247     if arch in ('X86_64', 'ARM64', 'X86_32'):
 248         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 249                  devmem_not_set)] # refers to LOCKDOWN
 250     if arch in ('X86_64', 'X86_32'):
 251         l += [KconfigCheck('cut_attack_surface', 'defconfig', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 252
 253     # 'cut_attack_surface', 'kspp'
 254     l += [KconfigCheck('cut_attack_surface', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 255     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 256     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 257     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 258     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 259     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 260     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 261     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 262     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 263     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 264     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT', 'is not set')]
 265     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 266     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 267     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32_ABI', 'is not set')]
 268     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 269     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 270     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 271     l += [modules_not_set]
 272     l += [devmem_not_set]
 273     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 274              devmem_not_set)] # refers to LOCKDOWN
 275     l += [AND(KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is not set'),
 276               KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is present'))]
 277     if arch in ('X86_64', 'X86_32'):
 278         l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 279               # CONFIG_COMPAT_VDSO disabled ASLR of vDSO only on X86_64 and X86_32;
 280               # on ARM64 this option has different meaning
 281     if arch == 'X86_64':
 282         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'X86_VSYSCALL_EMULATION', 'is not set'),
 283                  KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'))]
 284                  # disabling X86_VSYSCALL_EMULATION turns vsyscall off completely,
 285                  # and LEGACY_VSYSCALL_NONE can be changed at boot time via the cmdline parameter
 286     if arch == 'ARM':
 287         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 288                  devmem_not_set)] # refers to LOCKDOWN
 289
 290     # 'cut_attack_surface', 'grsec'
 291     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 292     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 293     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 294     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 295     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 296     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 297     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 298     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 299     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 300     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 301     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 302     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 303     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 304     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 305     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 306     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 307     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 308     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 309     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 310     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 311     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 312     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 313     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 314     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 315     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 316     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 317     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 318     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 319     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 320     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 321     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 322     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 323     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 324     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 325     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 326     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 327     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 328     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 329               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 330
 331     # 'cut_attack_surface', 'maintainer'
 332     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 333     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 334     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 335     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 336     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
 337     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'NOUVEAU_LEGACY_CTX_SUPPORT', 'is not set')]
 338                                             # recommended by Dave Airlie in kernel commit b30a43ac7132cdda
 339
 340     # 'cut_attack_surface', 'clipos'
 341     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 342     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 343     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 344     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 345     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 346     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 347     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 348     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 349     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 350     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 351 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 352
 353     # 'cut_attack_surface', 'lockdown'
 354     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 355     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 356     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 357     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 358
 359     # 'cut_attack_surface', 'my'
 360     l += [KconfigCheck('cut_attack_surface', 'my', 'LEGACY_TIOCSTI', 'is not set')]
 361     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 362     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 363     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 364     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 365     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 366     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 367     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 368     l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
 369     l += [KconfigCheck('cut_attack_surface', 'my', 'AIO', 'is not set')]
 370     l += [KconfigCheck('cut_attack_surface', 'my', 'CORESIGHT', 'is not set')]
 371     l += [KconfigCheck('cut_attack_surface', 'my', 'XFS_SUPPORT_V4', 'is not set')]
 372     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 373              modules_not_set)]
 374
 375     # 'harden_userspace'
 376     if arch == 'ARM64':
 377         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
 378         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_BTI', 'y')]
 379     if arch in ('ARM', 'X86_32'):
 380         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 381     l += [KconfigCheck('harden_userspace', 'clipos', 'COREDUMP', 'is not set')]
 382     l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', 'MAX')] # 'MAX' value is refined using ARCH_MMAP_RND_BITS_MAX
 383
 384
 385 def add_cmdline_checks(l, arch):
 386     assert(arch), 'empty arch'
 387
 388     # Calling the CmdlineCheck class constructor:
 389     #     CmdlineCheck(reason, decision, name, expected)
 390     #
 391     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
 392     #     when the tool doesn't check the cmdline.
 393     #
 394     # [!] Make sure that values of the options in CmdlineChecks need normalization.
 395     #     For more info see normalize_cmdline_options().
 396     #
 397     # A common pattern for checking the 'param_x' cmdline parameter
 398     # that __overrides__ the 'PARAM_X_DEFAULT' kconfig option:
 399     #   l += [OR(CmdlineCheck(reason, decision, 'param_x', '1'),
 400     #            AND(KconfigCheck(reason, decision, 'PARAM_X_DEFAULT_ON', 'y'),
 401     #                CmdlineCheck(reason, decision, 'param_x, 'is not set')))]
 402     #
 403     # Here we don't check the kconfig options or minimal kernel version
 404     # required for the cmdline parameters. That would make the checks
 405     # very complex and not give a 100% guarantee anyway.
 406
 407     # 'self_protection', 'defconfig'
 408     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmep', 'is not set')]
 409     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmap', 'is not set')]
 410     l += [CmdlineCheck('self_protection', 'defconfig', 'nokaslr', 'is not set')]
 411     l += [CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set')]
 412     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v1', 'is not set')]
 413     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v2', 'is not set')]
 414     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_bhb', 'is not set')]
 415     l += [CmdlineCheck('self_protection', 'defconfig', 'nospec_store_bypass_disable', 'is not set')]
 416     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nobti', 'is not set')]
 417     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nopauth', 'is not set')]
 418     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nomte', 'is not set')]
 419     if arch in ('X86_64', 'X86_32'):
 420         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not off'),
 421                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 422                      CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not set')))]
 423         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not off'),
 424                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 425                      CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not set')))]
 426         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not off'),
 427                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 428                      CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not set')))]
 429         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not off'),
 430                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 431                      CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not set')))]
 432         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not off'),
 433                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 434                      CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not set')))]
 435         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not off'),
 436                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 437                      CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not set')))]
 438         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not off'),
 439                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 440                      CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not set')))]
 441         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not off'),
 442                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 443                      CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not set')))]
 444         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not off'),
 445                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 446                      CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not set')))]
 447     if arch == 'ARM64':
 448         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not off'),
 449                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 450                      CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not set')))]
 451         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'kernel'),
 452                  CmdlineCheck('self_protection', 'my', 'ssbd', 'force-on'),
 453                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
 454                      CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'is not set')))]
 455         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
 456                  AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
 457                      CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]
 458     else:
 459         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'on'),
 460                  CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set'))]
 461
 462     # 'self_protection', 'kspp'
 463     l += [CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt')]
 464     l += [CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')] # consequence of 'slab_nomerge' by kspp
 465     l += [CmdlineCheck('self_protection', 'kspp', 'slub_merge', 'is not set')] # consequence of 'slab_nomerge' by kspp
 466     l += [CmdlineCheck('self_protection', 'kspp', 'page_alloc.shuffle', '1')]
 467     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge', 'is present'),
 468              AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
 469                  CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set'),
 470                  CmdlineCheck('self_protection', 'kspp', 'slub_merge', 'is not set')))]
 471     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
 472              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
 473                  CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
 474     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
 475              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 476                  CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
 477              AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
 478                  KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
 479                  CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
 480     l += [OR(CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', '1'),
 481              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y'),
 482                  CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', 'is not set')))]
 483     l += [AND(CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', 'is not set'),
 484               KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'))]
 485               # don't require slab_common.usercopy_fallback=0,
 486               # since HARDENED_USERCOPY_FALLBACK was removed in Linux v5.16
 487     if arch in ('X86_64', 'ARM64', 'X86_32'):
 488         l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
 489                  AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
 490                      CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
 491         l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', '0'),
 492                  AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set'),
 493                      CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', 'is not set')))]
 494         l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
 495                  AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
 496                      CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
 497     if arch in ('X86_64', 'X86_32'):
 498         l += [AND(CmdlineCheck('self_protection', 'kspp', 'pti', 'on'),
 499                   CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set'))]
 500
 501     # 'self_protection', 'clipos'
 502     if arch in ('X86_64', 'X86_32'):
 503         l += [CmdlineCheck('self_protection', 'clipos', 'iommu', 'force')]
 504
 505     # 'self_protection', 'my'
 506     l += [OR(CmdlineCheck('self_protection', 'my', 'kfence.sample_interval', 'is not off'),
 507              AND(KconfigCheck('self_protection', 'my', 'KFENCE_SAMPLE_INTERVAL', 'is not off'),
 508                  CmdlineCheck('self_protection', 'my', 'kfence.sample_interval', 'is not set')))]
 509
 510     # 'cut_attack_surface', 'defconfig'
 511     if arch in ('X86_64', 'X86_32'):
 512         l += [OR(CmdlineCheck('cut_attack_surface', 'defconfig', 'tsx', 'off'),
 513                  AND(KconfigCheck('cut_attack_surface', 'defconfig', 'X86_INTEL_TSX_MODE_OFF', 'y'),
 514                      CmdlineCheck('cut_attack_surface', 'defconfig', 'tsx', 'is not set')))]
 515
 516     # 'cut_attack_surface', 'kspp'
 517     l += [CmdlineCheck('cut_attack_surface', 'kspp', 'nosmt', 'is present')] # slow (high performance penalty)
 518     if arch == 'X86_64':
 519         l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
 520                  KconfigCheck('cut_attack_surface', 'kspp', 'X86_VSYSCALL_EMULATION', 'is not set'),
 521                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
 522                      CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
 523         l += [OR(CmdlineCheck('cut_attack_surface', 'my', 'vdso32', '1'),
 524                  CmdlineCheck('cut_attack_surface', 'my', 'vdso32', '0'),
 525                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set'),
 526                      CmdlineCheck('cut_attack_surface', 'my', 'vdso32', 'is not set')))] # the vdso32 parameter must not be 2
 527     if arch == 'X86_32':
 528         l += [OR(CmdlineCheck('cut_attack_surface', 'my', 'vdso32', '1'),
 529                  CmdlineCheck('cut_attack_surface', 'my', 'vdso', '1'),
 530                  CmdlineCheck('cut_attack_surface', 'my', 'vdso32', '0'),
 531                  CmdlineCheck('cut_attack_surface', 'my', 'vdso', '0'),
 532                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set'),
 533                      CmdlineCheck('cut_attack_surface', 'my', 'vdso32', 'is not set'),
 534                      CmdlineCheck('cut_attack_surface', 'my', 'vdso', 'is not set')))] # the vdso and vdso32 parameters must not be 2
 535
 536     # 'cut_attack_surface', 'grsec'
 537     # The cmdline checks compatible with the kconfig options disabled by grsecurity...
 538     l += [OR(CmdlineCheck('cut_attack_surface', 'grsec', 'debugfs', 'off'),
 539              KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set'))] # ... the end
 540
 541     # 'cut_attack_surface', 'my'
 542     l += [CmdlineCheck('cut_attack_surface', 'my', 'sysrq_always_enabled', 'is not set')]
 543
 544     # 'harden_userspace'
 545     l += [CmdlineCheck('harden_userspace', 'defconfig', 'norandmaps', 'is not set')]
 546
 547
 548 no_kstrtobool_options = [
 549     'debugfs', # See debugfs_kernel() in fs/debugfs/inode.c
 550     'mitigations', # See mitigations_parse_cmdline() in kernel/cpu.c
 551     'pti', # See pti_check_boottime_disable() in arch/x86/mm/pti.c
 552     'spectre_v2', # See spectre_v2_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 553     'spectre_v2_user', # See spectre_v2_parse_user_cmdline() in arch/x86/kernel/cpu/bugs.c
 554     'spec_store_bypass_disable', # See ssb_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 555     'l1tf', # See l1tf_cmdline() in arch/x86/kernel/cpu/bugs.c
 556     'mds', # See mds_cmdline() in arch/x86/kernel/cpu/bugs.c
 557     'tsx_async_abort', # See tsx_async_abort_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 558     'srbds', # See srbds_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 559     'mmio_stale_data', # See mmio_stale_data_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 560     'retbleed', # See retbleed_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 561     'rodata', # See set_debug_rodata() in init/main.c
 562     'ssbd', # See parse_spectre_v4_param() in arch/arm64/kernel/proton-pack.c
 563     'slub_debug', # See setup_slub_debug() in mm/slub.c
 564     'iommu', # See iommu_setup() in arch/x86/kernel/pci-dma.c
 565     'vsyscall', # See vsyscall_setup() in arch/x86/entry/vsyscall/vsyscall_64.c
 566     'vdso32', # See vdso32_setup() in arch/x86/entry/vdso/vdso32-setup.c
 567     'vdso', # See vdso32_setup() in arch/x86/entry/vdso/vdso32-setup.c
 568     'tsx' # See tsx_init() in arch/x86/kernel/cpu/tsx.c
 569 ]
 570
 571
 572 def normalize_cmdline_options(option, value):
 573     # Don't normalize the cmdline option values if
 574     # the Linux kernel doesn't use kstrtobool() for them
 575     if option in no_kstrtobool_options:
 576         return value
 577
 578     # Implement a limited part of the kstrtobool() logic
 579     if value.lower() in ('1', 'on', 'y', 'yes', 't', 'true'):
 580         return '1'
 581     if value.lower() in ('0', 'off', 'n', 'no', 'f', 'false'):
 582         return '0'
 583
 584     # Preserve unique values
 585     return value
 586
 587
 588 # TODO: draft of security hardening sysctls:
 589 #    what about bpf_jit_enable?
 590 #    vm.mmap_min_addr has a good value
 591 #    nosmt sysfs control file
 592 #    vm.mmap_rnd_bits=max (?)
 593 #    kernel.sysrq=0
 594 #    abi.vsyscall32 (any value except 2)
 595 #    kernel.oops_limit (think about a proper value)
 596 #    kernel.warn_limit (think about a proper value)
 597 #    net.ipv4.tcp_syncookies=1 (?)
 598
 599 def add_sysctl_checks(l, arch):
 600 # This function may be called with arch=None
 601
 602 # Calling the SysctlCheck class constructor:
 603 #   SysctlCheck(reason, decision, name, expected)
 604
 605     l += [SysctlCheck('self_protection', 'kspp', 'net.core.bpf_jit_harden', '2')]
 606
 607     l += [SysctlCheck('cut_attack_surface', 'kspp', 'kernel.dmesg_restrict', '1')]
 608     l += [SysctlCheck('cut_attack_surface', 'kspp', 'kernel.perf_event_paranoid', '3')] # with a custom patch, see https://lwn.net/Articles/696216/
 609     l += [SysctlCheck('cut_attack_surface', 'kspp', 'kernel.kexec_load_disabled', '1')]
 610     l += [SysctlCheck('cut_attack_surface', 'kspp', 'user.max_user_namespaces', '0')]
 611     l += [SysctlCheck('cut_attack_surface', 'kspp', 'dev.tty.ldisc_autoload', '0')]
 612     l += [SysctlCheck('cut_attack_surface', 'kspp', 'kernel.unprivileged_bpf_disabled', '1')]
 613     l += [SysctlCheck('cut_attack_surface', 'kspp', 'kernel.kptr_restrict', '2')]
 614     l += [SysctlCheck('cut_attack_surface', 'kspp', 'dev.tty.legacy_tiocsti', '0')]
 615     l += [SysctlCheck('cut_attack_surface', 'kspp', 'vm.unprivileged_userfaultfd', '0')]
 616           # At first, it disabled unprivileged userfaultfd,
 617           # and since v5.11 it enables unprivileged userfaultfd for user-mode only.
 618
 619     l += [SysctlCheck('cut_attack_surface', 'clipos', 'kernel.modules_disabled', '1')] # radical, but may be useful in some cases
 620
 621     l += [SysctlCheck('harden_userspace', 'kspp', 'fs.protected_symlinks', '1')]
 622     l += [SysctlCheck('harden_userspace', 'kspp', 'fs.protected_hardlinks', '1')]
 623     l += [SysctlCheck('harden_userspace', 'kspp', 'fs.protected_fifos', '2')]
 624     l += [SysctlCheck('harden_userspace', 'kspp', 'fs.protected_regular', '2')]
 625     l += [SysctlCheck('harden_userspace', 'kspp', 'fs.suid_dumpable', '0')]
 626     l += [SysctlCheck('harden_userspace', 'kspp', 'kernel.randomize_va_space', '2')]
 627     l += [SysctlCheck('harden_userspace', 'kspp', 'kernel.yama.ptrace_scope', '3')]