README.md

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