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