README.md

   1 # kconfig-hardened-check
   2
   3 [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/a13xp0p0v/kconfig-hardened-check?label=release)](https://github.com/a13xp0p0v/kconfig-hardened-check/tags)
   4 [![functional test](https://github.com/a13xp0p0v/kconfig-hardened-check/workflows/functional%20test/badge.svg)](https://github.com/a13xp0p0v/kconfig-hardened-check/actions/workflows/functional_test.yml)
   5 [![engine unit-test](https://github.com/a13xp0p0v/kconfig-hardened-check/workflows/engine%20unit-test/badge.svg)](https://github.com/a13xp0p0v/kconfig-hardened-check/actions/workflows/engine_unit-test.yml)
   6 [![Coverage Status](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check/graph/badge.svg)](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check)
   7
   8 ## Motivation
   9
  10 There are plenty of security hardening options for the Linux kernel. A lot of them are
  11 not enabled by the major distros. We have to enable these options ourselves to
  12 make our systems more secure.
  13
  14 But nobody likes checking configs manually. So let the computers do their job!
  15
  16 __kconfig-hardened-check__ helps me to check the Linux kernel options
  17 against my security hardening preferences, which are based on the
  18
  19   - [KSPP recommended settings][1]
  20   - [CLIP OS kernel configuration][2]
  21   - Last public [grsecurity][3] patch (options which they disable)
  22   - [SECURITY_LOCKDOWN_LSM][5] patchset
  23   - [Direct feedback from the Linux kernel maintainers][23]
  24
  25 This tool supports checking __Kconfig__ options and __kernel cmdline__ parameters.
  26
  27 I also created the [__Linux Kernel Defence Map__][4], which is a graphical representation of the
  28 relationships between security hardening features and the corresponding vulnerability classes
  29 or exploitation techniques.
  30
  31 __Attention!__ Changing Linux kernel security parameters may also affect system performance
  32 and functionality of userspace software. So for choosing these parameters consider
  33 the threat model of your Linux-based information system and perform thorough testing
  34 of its typical workload.
  35
  36 ## Repositories
  37
  38  - Main at GitHub <https://github.com/a13xp0p0v/kconfig-hardened-check>
  39  - Mirror at Codeberg: <https://codeberg.org/a13xp0p0v/kconfig-hardened-check>
  40  - Mirror at GitFlic: <https://gitflic.ru/project/a13xp0p0v/kconfig-hardened-check>
  41
  42 ## Supported microarchitectures
  43
  44   - X86_64
  45   - X86_32
  46   - ARM64
  47   - ARM
  48
  49 TODO: RISC-V (issue [#56][22])
  50
  51 ## Installation
  52
  53 You can install the package:
  54
  55 ```
  56 pip install git+https://github.com/a13xp0p0v/kconfig-hardened-check
  57 ```
  58
  59 or simply run `./bin/kconfig-hardened-check` from the cloned repository.
  60
  61 Some Linux distributions also provide `kconfig-hardened-check` as a package.
  62
  63 ## Usage
  64 ```
  65 usage: kconfig-hardened-check [-h] [--version] [-p {X86_64,X86_32,ARM64,ARM}]
  66                               [-c CONFIG]
  67                               [-l CMDLINE]
  68                               [-m {verbose,json,show_ok,show_fail}]
  69
  70 A tool for checking the security hardening options of the Linux kernel
  71
  72 optional arguments:
  73   -h, --help            show this help message and exit
  74   --version             show program's version number and exit
  75   -p {X86_64,X86_32,ARM64,ARM}, --print {X86_64,X86_32,ARM64,ARM}
  76                         print security hardening preferences for the selected architecture
  77   -c CONFIG, --config CONFIG
  78                         check the kernel kconfig file against these preferences
  79   -l CMDLINE, --cmdline CMDLINE
  80                         check the kernel cmdline file against these preferences
  81   -m {verbose,json,show_ok,show_fail}, --mode {verbose,json,show_ok,show_fail}
  82                         choose the report mode
  83 ```
  84
  85 ## Output modes
  86
  87   -  no `-m` argument for the default output mode (see the example below)
  88   - `-m verbose` for printing additional info:
  89     - config options without a corresponding check
  90     - internals of complex checks with AND/OR, like this:
  91 ```
  92 -------------------------------------------------------------------------------------------
  93     <<< OR >>>
  94 CONFIG_STRICT_DEVMEM                         |      y      |defconfig | cut_attack_surface
  95 CONFIG_DEVMEM                                | is not set  |   kspp   | cut_attack_surface
  96 -------------------------------------------------------------------------------------------
  97 ```
  98   - `-m show_fail` for showing only the failed checks
  99   - `-m show_ok` for showing only the successful checks
 100   - `-m json` for printing the results in JSON format (for combining `kconfig-hardened-check` with other tools)
 101
 102 ## Example output for `Fedora 36` kernel configuration
 103 ```
 104 $ ./bin/kconfig-hardened-check -c /boot/config-6.0.18-200.fc36.x86_64 -l /proc/cmdline
 105 [+] Kconfig file to check: /boot/config-6.0.18-200.fc36.x86_64
 106 [+] Kernel cmdline file to check: /proc/cmdline
 107 [+] Detected architecture: X86_64
 108 [+] Detected kernel version: 6.0
 109 [+] Detected compiler: GCC 120201
 110 =========================================================================================================================
 111               option name               | type  |desired val | decision |      reason      | check result
 112 =========================================================================================================================
 113 CONFIG_BUG                              |kconfig|     y      |defconfig | self_protection  | OK
 114 CONFIG_SLUB_DEBUG                       |kconfig|     y      |defconfig | self_protection  | OK
 115 CONFIG_THREAD_INFO_IN_TASK              |kconfig|     y      |defconfig | self_protection  | OK
 116 CONFIG_GCC_PLUGINS                      |kconfig|     y      |defconfig | self_protection  | OK
 117 CONFIG_IOMMU_SUPPORT                    |kconfig|     y      |defconfig | self_protection  | OK
 118 CONFIG_STACKPROTECTOR                   |kconfig|     y      |defconfig | self_protection  | OK
 119 CONFIG_STACKPROTECTOR_STRONG            |kconfig|     y      |defconfig | self_protection  | FAIL: "is not set"
 120 CONFIG_STRICT_KERNEL_RWX                |kconfig|     y      |defconfig | self_protection  | OK
 121 CONFIG_STRICT_MODULE_RWX                |kconfig|     y      |defconfig | self_protection  | OK
 122 CONFIG_REFCOUNT_FULL                    |kconfig|     y      |defconfig | self_protection  | OK: version >= 5.5
 123 CONFIG_RANDOMIZE_BASE                   |kconfig|     y      |defconfig | self_protection  | OK
 124 CONFIG_VMAP_STACK                       |kconfig|     y      |defconfig | self_protection  | OK
 125 CONFIG_DEBUG_WX                         |kconfig|     y      |defconfig | self_protection  | OK
 126 CONFIG_WERROR                           |kconfig|     y      |defconfig | self_protection  | FAIL: "is not set"
 127 CONFIG_X86_MCE                          |kconfig|     y      |defconfig | self_protection  | OK
 128 CONFIG_X86_MCE_INTEL                    |kconfig|     y      |defconfig | self_protection  | OK
 129 CONFIG_X86_MCE_AMD                      |kconfig|     y      |defconfig | self_protection  | OK
 130 CONFIG_MICROCODE                        |kconfig|     y      |defconfig | self_protection  | OK
 131 CONFIG_RETPOLINE                        |kconfig|     y      |defconfig | self_protection  | OK
 132 CONFIG_SYN_COOKIES                      |kconfig|     y      |defconfig | self_protection  | OK
 133 CONFIG_X86_SMAP                         |kconfig|     y      |defconfig | self_protection  | OK: version >= 5.19
 134 CONFIG_X86_UMIP                         |kconfig|     y      |defconfig | self_protection  | OK
 135 CONFIG_PAGE_TABLE_ISOLATION             |kconfig|     y      |defconfig | self_protection  | OK
 136 CONFIG_RANDOMIZE_MEMORY                 |kconfig|     y      |defconfig | self_protection  | OK
 137 CONFIG_INTEL_IOMMU                      |kconfig|     y      |defconfig | self_protection  | OK
 138 CONFIG_AMD_IOMMU                        |kconfig|     y      |defconfig | self_protection  | OK
 139 CONFIG_BUG_ON_DATA_CORRUPTION           |kconfig|     y      |   kspp   | self_protection  | OK
 140 CONFIG_SCHED_STACK_END_CHECK            |kconfig|     y      |   kspp   | self_protection  | OK
 141 CONFIG_SLAB_FREELIST_HARDENED           |kconfig|     y      |   kspp   | self_protection  | OK
 142 CONFIG_SLAB_FREELIST_RANDOM             |kconfig|     y      |   kspp   | self_protection  | OK
 143 CONFIG_SHUFFLE_PAGE_ALLOCATOR           |kconfig|     y      |   kspp   | self_protection  | OK
 144 CONFIG_FORTIFY_SOURCE                   |kconfig|     y      |   kspp   | self_protection  | OK
 145 CONFIG_DEBUG_LIST                       |kconfig|     y      |   kspp   | self_protection  | OK
 146 CONFIG_DEBUG_VIRTUAL                    |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 147 CONFIG_DEBUG_SG                         |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 148 CONFIG_DEBUG_CREDENTIALS                |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 149 CONFIG_DEBUG_NOTIFIERS                  |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 150 CONFIG_INIT_ON_ALLOC_DEFAULT_ON         |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 151 CONFIG_KFENCE                           |kconfig|     y      |   kspp   | self_protection  | OK
 152 CONFIG_ZERO_CALL_USED_REGS              |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 153 CONFIG_HW_RANDOM_TPM                    |kconfig|     y      |   kspp   | self_protection  | OK
 154 CONFIG_STATIC_USERMODEHELPER            |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 155 CONFIG_RANDSTRUCT_FULL                  |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 156 CONFIG_RANDSTRUCT_PERFORMANCE           |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_RANDSTRUCT_FULL is not "y"
 157 CONFIG_HARDENED_USERCOPY                |kconfig|     y      |   kspp   | self_protection  | OK
 158 CONFIG_HARDENED_USERCOPY_FALLBACK       |kconfig| is not set |   kspp   | self_protection  | OK: is not found
 159 CONFIG_HARDENED_USERCOPY_PAGESPAN       |kconfig| is not set |   kspp   | self_protection  | OK: is not found
 160 CONFIG_GCC_PLUGIN_LATENT_ENTROPY        |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 161 CONFIG_MODULE_SIG                       |kconfig|     y      |   kspp   | self_protection  | OK
 162 CONFIG_MODULE_SIG_ALL                   |kconfig|     y      |   kspp   | self_protection  | OK
 163 CONFIG_MODULE_SIG_SHA512                |kconfig|     y      |   kspp   | self_protection  | OK
 164 CONFIG_MODULE_SIG_FORCE                 |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 165 CONFIG_INIT_STACK_ALL_ZERO              |kconfig|     y      |   kspp   | self_protection  | OK
 166 CONFIG_INIT_ON_FREE_DEFAULT_ON          |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 167 CONFIG_EFI_DISABLE_PCI_DMA              |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 168 CONFIG_RESET_ATTACK_MITIGATION          |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 169 CONFIG_UBSAN_BOUNDS                     |kconfig|     y      |   kspp   | self_protection  | FAIL: is not found
 170 CONFIG_UBSAN_LOCAL_BOUNDS               |kconfig|     y      |   kspp   | self_protection  | FAIL: is not found
 171 CONFIG_UBSAN_TRAP                       |kconfig|     y      |   kspp   | self_protection  | FAIL: CONFIG_UBSAN_BOUNDS is not "y"
 172 CONFIG_UBSAN_SANITIZE_ALL               |kconfig|     y      |   kspp   | self_protection  | FAIL: CONFIG_UBSAN_BOUNDS is not "y"
 173 CONFIG_GCC_PLUGIN_STACKLEAK             |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 174 CONFIG_STACKLEAK_METRICS                |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_GCC_PLUGIN_STACKLEAK is not "y"
 175 CONFIG_STACKLEAK_RUNTIME_DISABLE        |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_GCC_PLUGIN_STACKLEAK is not "y"
 176 CONFIG_RANDOMIZE_KSTACK_OFFSET_DEFAULT  |kconfig|     y      |   kspp   | self_protection  | OK
 177 CONFIG_CFI_CLANG                        |kconfig|     y      |   kspp   | self_protection  | FAIL: is not found
 178 CONFIG_CFI_PERMISSIVE                   |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_CFI_CLANG is not "y"
 179 CONFIG_SCHED_CORE                       |kconfig|     y      |   kspp   | self_protection  | OK
 180 CONFIG_DEFAULT_MMAP_MIN_ADDR            |kconfig|   65536    |   kspp   | self_protection  | OK
 181 CONFIG_IOMMU_DEFAULT_DMA_STRICT         |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 182 CONFIG_IOMMU_DEFAULT_PASSTHROUGH        |kconfig| is not set |   kspp   | self_protection  | OK
 183 CONFIG_INTEL_IOMMU_DEFAULT_ON           |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
 184 CONFIG_SLS                              |kconfig|     y      |   kspp   | self_protection  | OK
 185 CONFIG_INTEL_IOMMU_SVM                  |kconfig|     y      |   kspp   | self_protection  | OK
 186 CONFIG_AMD_IOMMU_V2                     |kconfig|     y      |   kspp   | self_protection  | FAIL: "m"
 187 CONFIG_SLAB_MERGE_DEFAULT               |kconfig| is not set |  clipos  | self_protection  | OK
 188 CONFIG_SECURITY                         |kconfig|     y      |defconfig | security_policy  | OK
 189 CONFIG_SECURITY_YAMA                    |kconfig|     y      |   kspp   | security_policy  | OK
 190 CONFIG_SECURITY_LANDLOCK                |kconfig|     y      |   kspp   | security_policy  | OK
 191 CONFIG_SECURITY_SELINUX_DISABLE         |kconfig| is not set |   kspp   | security_policy  | OK
 192 CONFIG_SECURITY_SELINUX_BOOTPARAM       |kconfig| is not set |   kspp   | security_policy  | FAIL: "y"
 193 CONFIG_SECURITY_SELINUX_DEVELOP         |kconfig| is not set |   kspp   | security_policy  | FAIL: "y"
 194 CONFIG_SECURITY_LOCKDOWN_LSM            |kconfig|     y      |   kspp   | security_policy  | OK
 195 CONFIG_SECURITY_LOCKDOWN_LSM_EARLY      |kconfig|     y      |   kspp   | security_policy  | OK
 196 CONFIG_LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY|kconfig|     y      |   kspp   | security_policy  | FAIL: "is not set"
 197 CONFIG_SECURITY_WRITABLE_HOOKS          |kconfig| is not set |   kspp   | security_policy  | OK: is not found
 198 CONFIG_SECCOMP                          |kconfig|     y      |defconfig |cut_attack_surface| OK
 199 CONFIG_SECCOMP_FILTER                   |kconfig|     y      |defconfig |cut_attack_surface| OK
 200 CONFIG_BPF_UNPRIV_DEFAULT_OFF           |kconfig|     y      |defconfig |cut_attack_surface| OK
 201 CONFIG_STRICT_DEVMEM                    |kconfig|     y      |defconfig |cut_attack_surface| OK
 202 CONFIG_X86_INTEL_TSX_MODE_OFF           |kconfig|     y      |defconfig |cut_attack_surface| OK
 203 CONFIG_SECURITY_DMESG_RESTRICT          |kconfig|     y      |   kspp   |cut_attack_surface| FAIL: "is not set"
 204 CONFIG_ACPI_CUSTOM_METHOD               |kconfig| is not set |   kspp   |cut_attack_surface| OK
 205 CONFIG_COMPAT_BRK                       |kconfig| is not set |   kspp   |cut_attack_surface| OK
 206 CONFIG_DEVKMEM                          |kconfig| is not set |   kspp   |cut_attack_surface| OK: is not found
 207 CONFIG_COMPAT_VDSO                      |kconfig| is not set |   kspp   |cut_attack_surface| OK
 208 CONFIG_BINFMT_MISC                      |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "m"
 209 CONFIG_INET_DIAG                        |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 210 CONFIG_KEXEC                            |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 211 CONFIG_PROC_KCORE                       |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 212 CONFIG_LEGACY_PTYS                      |kconfig| is not set |   kspp   |cut_attack_surface| OK
 213 CONFIG_HIBERNATION                      |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 214 CONFIG_COMPAT                           |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 215 CONFIG_IA32_EMULATION                   |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 216 CONFIG_X86_X32                          |kconfig| is not set |   kspp   |cut_attack_surface| OK: is not found
 217 CONFIG_X86_X32_ABI                      |kconfig| is not set |   kspp   |cut_attack_surface| OK
 218 CONFIG_MODIFY_LDT_SYSCALL               |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 219 CONFIG_OABI_COMPAT                      |kconfig| is not set |   kspp   |cut_attack_surface| OK: is not found
 220 CONFIG_X86_MSR                          |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 221 CONFIG_MODULES                          |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 222 CONFIG_DEVMEM                           |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 223 CONFIG_IO_STRICT_DEVMEM                 |kconfig|     y      |   kspp   |cut_attack_surface| OK
 224 CONFIG_LDISC_AUTOLOAD                   |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
 225 CONFIG_LEGACY_VSYSCALL_NONE             |kconfig|     y      |   kspp   |cut_attack_surface| FAIL: "is not set"
 226 CONFIG_ZSMALLOC_STAT                    |kconfig| is not set |  grsec   |cut_attack_surface| OK
 227 CONFIG_PAGE_OWNER                       |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 228 CONFIG_DEBUG_KMEMLEAK                   |kconfig| is not set |  grsec   |cut_attack_surface| OK
 229 CONFIG_BINFMT_AOUT                      |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
 230 CONFIG_KPROBE_EVENTS                    |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 231 CONFIG_UPROBE_EVENTS                    |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 232 CONFIG_GENERIC_TRACER                   |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 233 CONFIG_FUNCTION_TRACER                  |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 234 CONFIG_STACK_TRACER                     |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 235 CONFIG_HIST_TRIGGERS                    |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 236 CONFIG_BLK_DEV_IO_TRACE                 |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 237 CONFIG_PROC_VMCORE                      |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 238 CONFIG_PROC_PAGE_MONITOR                |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 239 CONFIG_USELIB                           |kconfig| is not set |  grsec   |cut_attack_surface| OK
 240 CONFIG_CHECKPOINT_RESTORE               |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 241 CONFIG_USERFAULTFD                      |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 242 CONFIG_HWPOISON_INJECT                  |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "m"
 243 CONFIG_MEM_SOFT_DIRTY                   |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 244 CONFIG_DEVPORT                          |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 245 CONFIG_DEBUG_FS                         |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 246 CONFIG_NOTIFIER_ERROR_INJECTION         |kconfig| is not set |  grsec   |cut_attack_surface| OK
 247 CONFIG_FAIL_FUTEX                       |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
 248 CONFIG_PUNIT_ATOM_DEBUG                 |kconfig| is not set |  grsec   |cut_attack_surface| OK
 249 CONFIG_ACPI_CONFIGFS                    |kconfig| is not set |  grsec   |cut_attack_surface| OK
 250 CONFIG_EDAC_DEBUG                       |kconfig| is not set |  grsec   |cut_attack_surface| OK
 251 CONFIG_DRM_I915_DEBUG                   |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
 252 CONFIG_BCACHE_CLOSURES_DEBUG            |kconfig| is not set |  grsec   |cut_attack_surface| OK
 253 CONFIG_DVB_C8SECTPFE                    |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
 254 CONFIG_MTD_SLRAM                        |kconfig| is not set |  grsec   |cut_attack_surface| OK
 255 CONFIG_MTD_PHRAM                        |kconfig| is not set |  grsec   |cut_attack_surface| OK
 256 CONFIG_IO_URING                         |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 257 CONFIG_KCMP                             |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 258 CONFIG_RSEQ                             |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 259 CONFIG_LATENCYTOP                       |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 260 CONFIG_KCOV                             |kconfig| is not set |  grsec   |cut_attack_surface| OK
 261 CONFIG_PROVIDE_OHCI1394_DMA_INIT        |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 262 CONFIG_SUNRPC_DEBUG                     |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
 263 CONFIG_PTDUMP_DEBUGFS                   |kconfig| is not set |  grsec   |cut_attack_surface| OK
 264 CONFIG_DRM_LEGACY                       |kconfig| is not set |maintainer|cut_attack_surface| OK
 265 CONFIG_FB                               |kconfig| is not set |maintainer|cut_attack_surface| FAIL: "y"
 266 CONFIG_VT                               |kconfig| is not set |maintainer|cut_attack_surface| FAIL: "y"
 267 CONFIG_BLK_DEV_FD                       |kconfig| is not set |maintainer|cut_attack_surface| FAIL: "m"
 268 CONFIG_BLK_DEV_FD_RAWCMD                |kconfig| is not set |maintainer|cut_attack_surface| OK
 269 CONFIG_STAGING                          |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 270 CONFIG_KSM                              |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 271 CONFIG_KALLSYMS                         |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 272 CONFIG_X86_VSYSCALL_EMULATION           |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 273 CONFIG_MAGIC_SYSRQ                      |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 274 CONFIG_KEXEC_FILE                       |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 275 CONFIG_USER_NS                          |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 276 CONFIG_X86_CPUID                        |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 277 CONFIG_X86_IOPL_IOPERM                  |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 278 CONFIG_ACPI_TABLE_UPGRADE               |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 279 CONFIG_EFI_CUSTOM_SSDT_OVERLAYS         |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 280 CONFIG_COREDUMP                         |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
 281 CONFIG_EFI_TEST                         |kconfig| is not set | lockdown |cut_attack_surface| FAIL: "m"
 282 CONFIG_MMIOTRACE_TEST                   |kconfig| is not set | lockdown |cut_attack_surface| OK
 283 CONFIG_KPROBES                          |kconfig| is not set | lockdown |cut_attack_surface| FAIL: "y"
 284 CONFIG_BPF_SYSCALL                      |kconfig| is not set | lockdown |cut_attack_surface| FAIL: "y"
 285 CONFIG_MMIOTRACE                        |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
 286 CONFIG_LIVEPATCH                        |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
 287 CONFIG_IP_DCCP                          |kconfig| is not set |    my    |cut_attack_surface| OK
 288 CONFIG_IP_SCTP                          |kconfig| is not set |    my    |cut_attack_surface| FAIL: "m"
 289 CONFIG_FTRACE                           |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
 290 CONFIG_VIDEO_VIVID                      |kconfig| is not set |    my    |cut_attack_surface| OK: is not found
 291 CONFIG_INPUT_EVBUG                      |kconfig| is not set |    my    |cut_attack_surface| OK
 292 CONFIG_KGDB                             |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
 293 CONFIG_TRIM_UNUSED_KSYMS                |kconfig|     y      |    my    |cut_attack_surface| FAIL: is not found
 294 CONFIG_INTEGRITY                        |kconfig|     y      |defconfig | harden_userspace | OK
 295 CONFIG_ARCH_MMAP_RND_BITS               |kconfig|     32     |  clipos  | harden_userspace | FAIL: "28"
 296 nosmep                                  |cmdline| is not set |defconfig | self_protection  | OK: is not found
 297 nosmap                                  |cmdline| is not set |defconfig | self_protection  | OK: is not found
 298 nokaslr                                 |cmdline| is not set |defconfig | self_protection  | OK: is not found
 299 nopti                                   |cmdline| is not set |defconfig | self_protection  | OK: is not found
 300 nospectre_v1                            |cmdline| is not set |defconfig | self_protection  | OK: is not found
 301 nospectre_v2                            |cmdline| is not set |defconfig | self_protection  | OK: is not found
 302 nospectre_bhb                           |cmdline| is not set |defconfig | self_protection  | OK: is not found
 303 nospec_store_bypass_disable             |cmdline| is not set |defconfig | self_protection  | OK: is not found
 304 arm64.nobti                             |cmdline| is not set |defconfig | self_protection  | OK: is not found
 305 arm64.nopauth                           |cmdline| is not set |defconfig | self_protection  | OK: is not found
 306 arm64.nomte                             |cmdline| is not set |defconfig | self_protection  | OK: is not found
 307 mitigations                             |cmdline| is not off |defconfig | self_protection  | OK: mitigations is not found
 308 spectre_v2                              |cmdline| is not off |defconfig | self_protection  | OK: spectre_v2 is not found
 309 spectre_v2_user                         |cmdline| is not off |defconfig | self_protection  | OK: spectre_v2_user is not found
 310 spec_store_bypass_disable               |cmdline| is not off |defconfig | self_protection  | OK: spec_store_bypass_disable is not found
 311 l1tf                                    |cmdline| is not off |defconfig | self_protection  | OK: l1tf is not found
 312 mds                                     |cmdline| is not off |defconfig | self_protection  | OK: mds is not found
 313 tsx_async_abort                         |cmdline| is not off |defconfig | self_protection  | OK: tsx_async_abort is not found
 314 srbds                                   |cmdline| is not off |defconfig | self_protection  | OK: srbds is not found
 315 mmio_stale_data                         |cmdline| is not off |defconfig | self_protection  | OK: mmio_stale_data is not found
 316 retbleed                                |cmdline| is not off |defconfig | self_protection  | OK: retbleed is not found
 317 kpti                                    |cmdline| is not off |defconfig | self_protection  | OK: kpti is not found
 318 kvm.nx_huge_pages                       |cmdline| is not off |defconfig | self_protection  | OK: kvm.nx_huge_pages is not found
 319 rodata                                  |cmdline|     1      |defconfig | self_protection  | OK: rodata is not found
 320 nosmt                                   |cmdline| is present |   kspp   | self_protection  | FAIL: is not present
 321 init_on_alloc                           |cmdline|     1      |   kspp   | self_protection  | FAIL: is not found
 322 init_on_free                            |cmdline|     1      |   kspp   | self_protection  | FAIL: is not found
 323 slab_nomerge                            |cmdline| is present |   kspp   | self_protection  | OK: CONFIG_SLAB_MERGE_DEFAULT is "is not set"
 324 iommu.strict                            |cmdline|     1      |   kspp   | self_protection  | FAIL: is not found
 325 iommu.passthrough                       |cmdline|     0      |   kspp   | self_protection  | OK: CONFIG_IOMMU_DEFAULT_PASSTHROUGH is "is not set"
 326 hardened_usercopy                       |cmdline|     1      |   kspp   | self_protection  | OK: CONFIG_HARDENED_USERCOPY is "y"
 327 slab_common.usercopy_fallback           |cmdline|     0      |   kspp   | self_protection  | OK: CONFIG_HARDENED_USERCOPY_FALLBACK is not found
 328 randomize_kstack_offset                 |cmdline|     1      |   kspp   | self_protection  | OK: CONFIG_RANDOMIZE_KSTACK_OFFSET_DEFAULT is "y"
 329 pti                                     |cmdline|     on     |   kspp   | self_protection  | FAIL: is not found
 330 page_alloc.shuffle                      |cmdline|     1      |  clipos  | self_protection  | FAIL: is not found
 331 iommu                                   |cmdline|   force    |  clipos  | self_protection  | FAIL: is not found
 332 tsx                                     |cmdline|    off     |defconfig |cut_attack_surface| OK: CONFIG_X86_INTEL_TSX_MODE_OFF is "y"
 333 vsyscall                                |cmdline|    none    |   kspp   |cut_attack_surface| FAIL: is not found
 334 debugfs                                 |cmdline|    off     |  grsec   |cut_attack_surface| FAIL: is not found
 335 sysrq_always_enabled                    |cmdline| is not set |    my    |cut_attack_surface| OK: is not found
 336
 337 [+] Config check is finished: 'OK' - 122 / 'FAIL' - 101
 338 ```
 339
 340 ## kconfig-hardened-check versioning
 341
 342 I usually update the kernel security hardening recommendations every few kernel releases.
 343
 344 So the version of `kconfig-hardened-check` is associated with the corresponding version of the kernel.
 345
 346 The version format is: __[major_number].[kernel_version].[kernel_patchlevel]__
 347
 348
 349 ## Questions and answers
 350
 351 __Q:__ How all these kernel parameters influence the Linux kernel security?
 352
 353 __A:__ To answer this question, you can use the `kconfig-hardened-check` [sources of recommendations][24]
 354 and the [Linux Kernel Defence Map][4] with its references.
 355
 356 <br />
 357
 358 __Q:__ How disabling `CONFIG_USER_NS` cuts the attack surface? It's needed for containers!
 359
 360 __A:__ Yes, the `CONFIG_USER_NS` option provides some isolation between the userspace programs,
 361 but the tool recommends disabling it to cut the attack surface __of the kernel__.
 362
 363 The rationale:
 364
 365   - An LWN article about the corresponding LKML discussion: https://lwn.net/Articles/673597/
 366
 367   - A twitter thread about `CONFIG_USER_NS` and security: https://twitter.com/robertswiecki/status/1095447678949953541
 368
 369   - A good overview of the trade-off between having user namespaces enabled, disabled and available only for root: https://github.com/NixOS/nixpkgs/pull/84522#issuecomment-614640601
 370
 371 <br />
 372
 373 __Q:__ KSPP and CLIP OS recommend `CONFIG_PANIC_ON_OOPS=y`. Why doesn't this tool do the same?
 374
 375 __A:__ I personally don't support this recommendation because:
 376   - It decreases system safety (kernel oops is still not a rare situation)
 377   - It allows easier denial-of-service attacks for the whole system
 378
 379 I think having `CONFIG_BUG` is enough here.
 380 If a kernel oops happens in the process context, the offending/attacking process is killed.
 381 In other cases, the kernel panics, which is similar to `CONFIG_PANIC_ON_OOPS=y`.
 382
 383 <br />
 384
 385 __Q:__ Why enabling `CONFIG_STATIC_USERMODEHELPER` breaks various things in my GNU/Linux system?
 386 Do I really need that feature?
 387
 388 __A:__ Linux kernel usermode helpers can be used for privilege escalation in kernel exploits
 389 ([example 1][9], [example 2][10]). `CONFIG_STATIC_USERMODEHELPER` prevents that method. But it
 390 requires the corresponding support in the userspace: see the [example implementation][11] by
 391 Tycho Andersen [@tych0][12].
 392
 393 <br />
 394
 395 __Q:__ What about performance impact of these security hardening options?
 396
 397 __A:__ Ike Devolder [@BlackIkeEagle][7] made some performance tests and described the results in [this article][8].
 398 A more detailed evaluation is in the TODO list (the issue [#66][21]).
 399
 400 <br />
 401
 402 __Q:__ Can I easily check which kernel versions support some Kconfig option?
 403
 404 __A:__ Yes. See the [LKDDb][18] project (Linux Kernel Driver Database) by Giacomo Catenazzi [@cateee][19].
 405 You can use it for the `mainline` or `stable` tree from [kernel.org][20] or for your custom kernel sources.
 406
 407 <br />
 408
 409 __Q:__ Does my kernel have all those mitigations of Transient Execution Vulnerabilities in my hardware?
 410
 411 __A:__ Checking the kernel config is not enough to answer this question.
 412 I highly recommend using [spectre-meltdown-checker][13] tool maintained by Stéphane Lesimple [@speed47][14].
 413
 414 <br />
 415
 416 __Q:__ Why the `CONFIG_GCC_PLUGINS` option is automatically disabled during the kernel compilation?
 417
 418 __A:__ It means that your gcc doesn't support plugins. For example, if you have `gcc-7` on Ubuntu,
 419 try to install `gcc-7-plugin-dev` package, it should help.
 420
 421
 422 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
 423 [2]: https://docs.clip-os.org/clipos/kernel.html#configuration
 424 [3]: https://grsecurity.net/
 425 [4]: https://github.com/a13xp0p0v/linux-kernel-defence-map
 426 [5]: https://lwn.net/Articles/791863/
 427 [6]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/38
 428 [7]: https://github.com/BlackIkeEagle
 429 [8]: https://blog.herecura.eu/blog/2020-05-30-kconfig-hardening-tests/
 430 [9]: https://googleprojectzero.blogspot.com/2018/09/a-cache-invalidation-bug-in-linux.html
 431 [10]: https://a13xp0p0v.github.io/2020/02/15/CVE-2019-18683.html
 432 [11]: https://github.com/tych0/huldufolk
 433 [12]: https://github.com/tych0
 434 [13]: https://github.com/speed47/spectre-meltdown-checker
 435 [14]: https://github.com/speed47
 436 [15]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/53
 437 [16]: https://github.com/a13xp0p0v/kconfig-hardened-check/pull/54
 438 [17]: https://github.com/a13xp0p0v/kconfig-hardened-check/pull/62
 439 [18]: https://cateee.net/lkddb/web-lkddb/
 440 [19]: https://github.com/cateee/lkddb
 441 [20]: https://kernel.org/
 442 [21]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/66
 443 [22]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/56
 444 [23]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues?q=label%3Akernel_maintainer_feedback
 445 [24]: https://github.com/a13xp0p0v/kconfig-hardened-check#motivation