Commit 3f293bca by Alexander Popov

Update the README (describing installation)

parent 3c078276
......@@ -26,12 +26,20 @@ or exploitation techniques.
- ARM64
- ARM
## 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
......@@ -45,15 +53,15 @@ optional arguments:
--json print results in JSON format
```
### 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
=========================================================================================================================
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment