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