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