README.md

   1 # Kconfig hardened check
   2
   3 ## Motivation
   4
   5 There are plenty of Linux kernel hardening config options. A lot of them are
   6 not enabled by the major distros. We have to enable these options ourselves to
   7 make our systems more secure.
   8
   9 But nobody likes checking configs manually. So let the computers do their job!
  10
  11 __kconfig-hardened-check.py__ helps me to check the Linux kernel Kconfig option list
  12 against my hardening preferences for `x86_64`, which are based on the
  13 [KSPP recommended settings][1] and last public [grsecurity][2] patch (options
  14 which they disable).
  15
  16 Please don't cry if my Python code looks like C. I'm just a kernel developer.
  17
  18 __TODO:__ add hardening preferences for ARM.
  19
  20 ## Script output examples
  21
  22 ### Usage
  23 ```
  24 #./kconfig-hardened-check.py
  25 usage: kconfig-hardened-check.py [-h] [-p {X86_64,X86_32,ARM64}] [-c CONFIG]
  26                                  [--debug]
  27
  28 Checks the hardening options in the Linux kernel config
  29
  30 optional arguments:
  31   -h, --help            show this help message and exit
  32   -p {X86_64,X86_32,ARM64}, --print {X86_64,X86_32,ARM64}
  33                         print hardening preferences for selected architecture
  34   -c CONFIG, --config CONFIG
  35                         check the config_file against these preferences
  36   --debug               enable internal debug mode
  37 ```
  38
  39 ### Script output for `Ubuntu 18.04 (Bionic Beaver)` kernel config
  40 ```
  41 #./kconfig-hardened-check.py -c config_files/distros/ubuntu-bionic-generic.config
  42 [+] Trying to detect architecture in "config_files/distros/ubuntu-bionic-generic.config"...
  43 [+] Detected architecture: X86_64
  44 [+] Checking "config_files/distros/ubuntu-bionic-generic.config" against hardening preferences...
  45   option name                            | desired val | decision |       reason       ||        check result
  46   ===================================================================================================================
  47   CONFIG_BUG                             |      y      |defconfig |  self_protection   ||             OK
  48   CONFIG_STRICT_KERNEL_RWX               |      y      |defconfig |  self_protection   ||             OK
  49   CONFIG_STACKPROTECTOR_STRONG           |      y      |defconfig |  self_protection   ||CONFIG_CC_STACKPROTECTOR_STRONG: OK ("y")
  50   CONFIG_THREAD_INFO_IN_TASK             |      y      |defconfig |  self_protection   ||             OK
  51   CONFIG_SLUB_DEBUG                      |      y      |defconfig |  self_protection   ||             OK
  52   CONFIG_STRICT_MODULE_RWX               |      y      |defconfig |  self_protection   ||             OK
  53   CONFIG_PAGE_TABLE_ISOLATION            |      y      |defconfig |  self_protection   ||             OK
  54   CONFIG_RANDOMIZE_MEMORY                |      y      |defconfig |  self_protection   ||             OK
  55   CONFIG_RANDOMIZE_BASE                  |      y      |defconfig |  self_protection   ||             OK
  56   CONFIG_RETPOLINE                       |      y      |defconfig |  self_protection   ||             OK
  57   CONFIG_X86_SMAP                        |      y      |defconfig |  self_protection   ||             OK
  58   CONFIG_X86_INTEL_UMIP                  |      y      |defconfig |  self_protection   ||             OK
  59   CONFIG_SYN_COOKIES                     |      y      |defconfig |  self_protection   ||             OK
  60   CONFIG_VMAP_STACK                      |      y      |defconfig |  self_protection   ||             OK
  61   CONFIG_BUG_ON_DATA_CORRUPTION          |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  62   CONFIG_DEBUG_WX                        |      y      |   kspp   |  self_protection   ||             OK
  63   CONFIG_SCHED_STACK_END_CHECK           |      y      |   kspp   |  self_protection   ||             OK
  64   CONFIG_PAGE_POISONING                  |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  65   CONFIG_SLAB_FREELIST_HARDENED          |      y      |   kspp   |  self_protection   ||             OK
  66   CONFIG_SLAB_FREELIST_RANDOM            |      y      |   kspp   |  self_protection   ||             OK
  67   CONFIG_HARDENED_USERCOPY               |      y      |   kspp   |  self_protection   ||             OK
  68   CONFIG_HARDENED_USERCOPY_FALLBACK      | is not set  |   kspp   |  self_protection   ||       OK: not found
  69   CONFIG_FORTIFY_SOURCE                  |      y      |   kspp   |  self_protection   ||             OK
  70   CONFIG_GCC_PLUGINS                     |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  71   CONFIG_GCC_PLUGIN_RANDSTRUCT           |      y      |   kspp   |  self_protection   ||      FAIL: not found
  72   CONFIG_GCC_PLUGIN_STRUCTLEAK           |      y      |   kspp   |  self_protection   ||      FAIL: not found
  73   CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF_ALL |      y      |   kspp   |  self_protection   ||      FAIL: not found
  74   CONFIG_GCC_PLUGIN_LATENT_ENTROPY       |      y      |   kspp   |  self_protection   ||      FAIL: not found
  75   CONFIG_DEBUG_LIST                      |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  76   CONFIG_DEBUG_SG                        |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  77   CONFIG_DEBUG_CREDENTIALS               |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  78   CONFIG_DEBUG_NOTIFIERS                 |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  79   CONFIG_MODULE_SIG                      |      y      |   kspp   |  self_protection   ||             OK
  80   CONFIG_MODULE_SIG_ALL                  |      y      |   kspp   |  self_protection   ||             OK
  81   CONFIG_MODULE_SIG_SHA512               |      y      |   kspp   |  self_protection   ||             OK
  82   CONFIG_MODULE_SIG_FORCE                |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  83   CONFIG_DEFAULT_MMAP_MIN_ADDR           |    65536    |   kspp   |  self_protection   ||             OK
  84   CONFIG_REFCOUNT_FULL                   |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  85   CONFIG_GCC_PLUGIN_STACKLEAK            |      y      |    my    |  self_protection   ||      FAIL: not found
  86   CONFIG_LOCK_DOWN_KERNEL                |      y      |    my    |  self_protection   ||             OK
  87   CONFIG_SLUB_DEBUG_ON                   |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  88   CONFIG_SECURITY_DMESG_RESTRICT         |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  89   CONFIG_STATIC_USERMODEHELPER           |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  90   CONFIG_SECURITY_LOADPIN                |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  91   CONFIG_PAGE_POISONING_NO_SANITY        | is not set  |    my    |  self_protection   ||       OK: not found
  92   CONFIG_PAGE_POISONING_ZERO             | is not set  |    my    |  self_protection   ||       OK: not found
  93   CONFIG_SLAB_MERGE_DEFAULT              | is not set  |    my    |  self_protection   ||         FAIL: "y"
  94   CONFIG_SECURITY                        |      y      |defconfig |  security_policy   ||             OK
  95   CONFIG_SECURITY_YAMA                   |      y      |   kspp   |  security_policy   ||             OK
  96   CONFIG_SECURITY_SELINUX_DISABLE        | is not set  |   kspp   |  security_policy   ||             OK
  97   CONFIG_SECCOMP                         |      y      |defconfig | cut_attack_surface ||             OK
  98   CONFIG_SECCOMP_FILTER                  |      y      |defconfig | cut_attack_surface ||             OK
  99   CONFIG_STRICT_DEVMEM                   |      y      |defconfig | cut_attack_surface ||             OK
 100   CONFIG_IO_STRICT_DEVMEM                |      y      |   kspp   | cut_attack_surface ||     FAIL: "is not set"
 101   CONFIG_ACPI_CUSTOM_METHOD              | is not set  |   kspp   | cut_attack_surface ||             OK
 102   CONFIG_COMPAT_BRK                      | is not set  |   kspp   | cut_attack_surface ||             OK
 103   CONFIG_DEVKMEM                         | is not set  |   kspp   | cut_attack_surface ||             OK
 104   CONFIG_COMPAT_VDSO                     | is not set  |   kspp   | cut_attack_surface ||             OK
 105   CONFIG_BINFMT_MISC                     | is not set  |   kspp   | cut_attack_surface ||         FAIL: "m"
 106   CONFIG_INET_DIAG                       | is not set  |   kspp   | cut_attack_surface ||         FAIL: "m"
 107   CONFIG_KEXEC                           | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 108   CONFIG_PROC_KCORE                      | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 109   CONFIG_LEGACY_PTYS                     | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 110   CONFIG_HIBERNATION                     | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 111   CONFIG_LEGACY_VSYSCALL_NONE            |      y      |   kspp   | cut_attack_surface ||     FAIL: "is not set"
 112   CONFIG_IA32_EMULATION                  | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 113   CONFIG_X86_X32                         | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 114   CONFIG_MODIFY_LDT_SYSCALL              | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 115   CONFIG_X86_PTDUMP                      | is not set  |grsecurity| cut_attack_surface ||             OK
 116   CONFIG_ZSMALLOC_STAT                   | is not set  |grsecurity| cut_attack_surface ||             OK
 117   CONFIG_PAGE_OWNER                      | is not set  |grsecurity| cut_attack_surface ||             OK
 118   CONFIG_DEBUG_KMEMLEAK                  | is not set  |grsecurity| cut_attack_surface ||             OK
 119   CONFIG_BINFMT_AOUT                     | is not set  |grsecurity| cut_attack_surface ||       OK: not found
 120   CONFIG_KPROBES                         | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 121   CONFIG_UPROBES                         | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 122   CONFIG_GENERIC_TRACER                  | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 123   CONFIG_PROC_VMCORE                     | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 124   CONFIG_PROC_PAGE_MONITOR               | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 125   CONFIG_USELIB                          | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 126   CONFIG_CHECKPOINT_RESTORE              | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 127   CONFIG_USERFAULTFD                     | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 128   CONFIG_HWPOISON_INJECT                 | is not set  |grsecurity| cut_attack_surface ||         FAIL: "m"
 129   CONFIG_MEM_SOFT_DIRTY                  | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 130   CONFIG_DEVPORT                         | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 131   CONFIG_DEBUG_FS                        | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 132   CONFIG_NOTIFIER_ERROR_INJECTION        | is not set  |grsecurity| cut_attack_surface ||         FAIL: "m"
 133   CONFIG_ACPI_TABLE_UPGRADE              | is not set  | lockdown | cut_attack_surface ||         FAIL: "y"
 134   CONFIG_ACPI_APEI_EINJ                  | is not set  | lockdown | cut_attack_surface ||         FAIL: "m"
 135   CONFIG_PROFILING                       | is not set  | lockdown | cut_attack_surface ||         FAIL: "y"
 136   CONFIG_BPF_SYSCALL                     | is not set  | lockdown | cut_attack_surface ||         FAIL: "y"
 137   CONFIG_MMIOTRACE_TEST                  | is not set  | lockdown | cut_attack_surface ||             OK
 138   CONFIG_MMIOTRACE                       | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 139   CONFIG_KEXEC_FILE                      | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 140   CONFIG_LIVEPATCH                       | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 141   CONFIG_USER_NS                         | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 142   CONFIG_IP_DCCP                         | is not set  |    my    | cut_attack_surface ||         FAIL: "m"
 143   CONFIG_IP_SCTP                         | is not set  |    my    | cut_attack_surface ||         FAIL: "m"
 144   CONFIG_FTRACE                          | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 145   CONFIG_BPF_JIT                         | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 146   CONFIG_ARCH_MMAP_RND_BITS              |     32      |    my    |userspace_protection||         FAIL: "28"
 147
 148 [-] config check is NOT PASSED: 56 errors
 149 ```
 150
 151 __Go and fix them all!__
 152
 153
 154 N.B. If `CONFIG_GCC_PLUGIN*` options are automatically disabled during your kernel compilation,
 155 then your gcc doesn't support plugins. For example, if you have `gcc-7` on Ubuntu, try to install
 156 `gcc-7-plugin-dev` package, it should help.
 157
 158
 159 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
 160 [2]: https://grsecurity.net/