-# Kconfig hardened check
+# kconfig-hardened-check
## Motivation
- ARM64
- ARM
-## Script output examples
+## Installation
-### Usage
+You can install the package:
+
+```
+pip install git+https://github.com/a13xp0p0v/kconfig-hardened-check'
+```
+
+or simply run `./bin/kconfig-hardened-check` from the cloned repository.
+
+## Usage
```
-usage: kconfig-hardened-check.py [-h] [-p {X86_64,X86_32,ARM64,ARM}]
- [-c CONFIG] [--debug] [--json]
+usage: kconfig-hardened-check [-h] [-p {X86_64,X86_32,ARM64,ARM}] [-c CONFIG]
+ [--debug] [--json]
Checks the hardening options in the Linux kernel config
--json print results in JSON format
```
-### Script output for `Ubuntu 18.04 (Bionic Beaver with HWE)` kernel config
+## Output for `Ubuntu 18.04 (Bionic Beaver with HWE)` kernel config
```
-$ ./kconfig-hardened-check.py -c config_files/distros/ubuntu-bionic-generic.config
-[+] Trying to detect architecture in "config_files/distros/ubuntu-bionic-generic.config"...
+$ ./bin/kconfig-hardened-check -c kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config
+[+] Trying to detect architecture in "kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config"...
[+] Detected architecture: X86_64
-[+] Trying to detect kernel version in "config_files/distros/ubuntu-bionic-generic.config"...
+[+] Trying to detect kernel version in "kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config"...
[+] Found version line: "# Linux/x86 5.3.0-28-generic Kernel Configuration"
[+] Detected kernel version: 5.3
-[+] Checking "config_files/distros/ubuntu-bionic-generic.config" against X86_64 hardening preferences...
+[+] Checking "kconfig_hardened_check/config_files/distros/ubuntu-bionic-generic.config" against X86_64 hardening preferences...
=========================================================================================================================
option name | desired val | decision | reason | check result
=========================================================================================================================
The version format is: __[major_number].[kernel_version]__
-The current version of `kconfig-hardened-check` is __0.5.3__, it's marked with the git tag.
+The current version of `kconfig-hardened-check` is __0.5.5__, it's marked with the git tag.
## Questions and answers
__Q:__ How disabling `CONFIG_USER_NS` cuts the attack surface? It's needed for containers!
__A:__ Yes, the `CONFIG_USER_NS` option provides some isolation between the userspace programs,
-but the script recommends disabling it to cut the attack surface __of the kernel__.
+but the tool recommends disabling it to cut the attack surface __of the kernel__.
The rationale: