Add the GitHub link
[kconfig-hardened-check.git] / kconfig_hardened_check / checks.py
index 5b917bfbfd41d5cc0f8dc781df6f512c0de51ea6..b0b9a685049f15c29206251ce7a60ab5e2a89e6b 100644 (file)
@@ -1,5 +1,15 @@
 #!/usr/bin/python3
 
+"""
+This tool helps me to check Linux kernel options against
+my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
+Let the computers do their job!
+
+Author: Alexander Popov <alex.popov@linux.com>
+
+This module contains knowledge for checks.
+"""
+
 # N.B. Hardening sysctls:
 #    kernel.kptr_restrict=2 (or 1?)
 #    kernel.dmesg_restrict=1 (also see the kconfig option)
@@ -33,8 +43,8 @@
 #    amd_iommu=on
 #    efi=disable_early_pci_dma
 
-# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
-# pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
+# pylint: disable=missing-function-docstring,line-too-long,invalid-name
+# pylint: disable=too-many-branches,too-many-statements,too-many-return-statements
 
 from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND
 
@@ -429,31 +439,43 @@ def add_cmdline_checks(l, arch):
     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nopauth', 'is not set')]
     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nomte', 'is not set')]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not set')))]
     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'kvm.nx_huge_pages', 'is not off'),
-             CmdlineCheck('self_protection', 'defconfig', 'kvm.nx_huge_pages', 'is not set'))]
+             AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                 CmdlineCheck('self_protection', 'defconfig', 'kvm.nx_huge_pages', 'is not set')))]
     if arch == 'ARM64':
         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'kernel'),
                  CmdlineCheck('self_protection', 'my', 'ssbd', 'force-on'),
-                 CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'is not set'))]
+                 AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
+                     CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'is not set')))]
         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
                  AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
                      CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]