projects
/
kconfig-hardened-check.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Skip normalize_cmdline_options() for the iommu cmdline parameter
[kconfig-hardened-check.git]
/
kconfig_hardened_check
/
__init__.py
diff --git
a/kconfig_hardened_check/__init__.py
b/kconfig_hardened_check/__init__.py
index f89ac983a1694012b8faefc586e294e5fe7fbd13..086e21e3769d3569ec4eb4672b7920614d4fc9c5 100644
(file)
--- a/
kconfig_hardened_check/__init__.py
+++ b/
kconfig_hardened_check/__init__.py
@@
-1,9
+1,7
@@
#!/usr/bin/python3
"""
#!/usr/bin/python3
"""
-This tool helps me to check Linux kernel options against
-my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
-Let the computers do their job!
+This tool is for checking the security hardening options of the Linux kernel.
Author: Alexander Popov <alex.popov@linux.com>
Author: Alexander Popov <alex.popov@linux.com>
@@
-12,6
+10,7
@@
This module performs input/output.
# pylint: disable=missing-function-docstring,line-too-long,invalid-name,too-many-branches,too-many-statements
# pylint: disable=missing-function-docstring,line-too-long,invalid-name,too-many-branches,too-many-statements
+import gzip
import sys
from argparse import ArgumentParser
from collections import OrderedDict
import sys
from argparse import ArgumentParser
from collections import OrderedDict
@@
-19,11
+18,19
@@
import re
import json
from .__about__ import __version__
from .checks import add_kconfig_checks, add_cmdline_checks, normalize_cmdline_options
import json
from .__about__ import __version__
from .checks import add_kconfig_checks, add_cmdline_checks, normalize_cmdline_options
-from .engine import populate_with_data, perform_checks
+from .engine import populate_with_data, perform_checks, override_expected_value
+
+
+def _open(file: str, *args, **kwargs):
+ open_method = open
+ if file.endswith(".gz"):
+ open_method = gzip.open
+
+ return open_method(file, *args, **kwargs)
def detect_arch(fname, archs):
def detect_arch(fname, archs):
- with
open(fname, 'r
', encoding='utf-8') as f:
+ with
_open(fname, 'rt
', encoding='utf-8') as f:
arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
arch = None
for line in f.readlines():
arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
arch = None
for line in f.readlines():
@@
-40,7
+47,7
@@
def detect_arch(fname, archs):
def detect_kernel_version(fname):
def detect_kernel_version(fname):
- with
open(fname, 'r
', encoding='utf-8') as f:
+ with
_open(fname, 'rt
', encoding='utf-8') as f:
ver_pattern = re.compile("# Linux/.* Kernel Configuration")
for line in f.readlines():
if ver_pattern.match(line):
ver_pattern = re.compile("# Linux/.* Kernel Configuration")
for line in f.readlines():
if ver_pattern.match(line):
@@
-49,7
+56,7
@@
def detect_kernel_version(fname):
ver_str = parts[2]
ver_numbers = ver_str.split('.')
if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
ver_str = parts[2]
ver_numbers = ver_str.split('.')
if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
- msg =
'failed to parse the version "' + ver_str + '
"'
+ msg =
f'failed to parse the version "{ver_str}
"'
return None, msg
return (int(ver_numbers[0]), int(ver_numbers[1])), None
return None, 'no kernel version detected'
return None, msg
return (int(ver_numbers[0]), int(ver_numbers[1])), None
return None, 'no kernel version detected'
@@
-58,7
+65,7
@@
def detect_kernel_version(fname):
def detect_compiler(fname):
gcc_version = None
clang_version = None
def detect_compiler(fname):
gcc_version = None
clang_version = None
- with
open(fname, 'r
', encoding='utf-8') as f:
+ with
_open(fname, 'rt
', encoding='utf-8') as f:
gcc_version_pattern = re.compile("CONFIG_GCC_VERSION=[0-9]*")
clang_version_pattern = re.compile("CONFIG_CLANG_VERSION=[0-9]*")
for line in f.readlines():
gcc_version_pattern = re.compile("CONFIG_GCC_VERSION=[0-9]*")
clang_version_pattern = re.compile("CONFIG_CLANG_VERSION=[0-9]*")
for line in f.readlines():
@@
-101,8
+108,8
@@
def print_unknown_options(checklist, parsed_options):
def print_checklist(mode, checklist, with_results):
if mode == 'json':
output = []
def print_checklist(mode, checklist, with_results):
if mode == 'json':
output = []
- for o in checklist:
- output.append(o.json_dump(with_results))
+ for o
pt
in checklist:
+ output.append(o
pt
.json_dump(with_results))
print(json.dumps(output))
return
print(json.dumps(output))
return
@@
-111,7
+118,7
@@
def print_checklist(mode, checklist, with_results):
if with_results:
sep_line_len += 30
print('=' * sep_line_len)
if with_results:
sep_line_len += 30
print('=' * sep_line_len)
- print(f
"{'option name':^40}|{'type':^7}|{'desired val':^12}|{'decision':^10}|{'reason':^18}"
, end='')
+ print(f
'{"option name":^40}|{"type":^7}|{"desired val":^12}|{"decision":^10}|{"reason":^18}'
, end='')
if with_results:
print('| check result', end='')
print()
if with_results:
print('| check result', end='')
print()
@@
-142,12
+149,11
@@
def print_checklist(mode, checklist, with_results):
fail_suppressed = ' (suppressed in output)'
if mode == 'show_fail':
ok_suppressed = ' (suppressed in output)'
fail_suppressed = ' (suppressed in output)'
if mode == 'show_fail':
ok_suppressed = ' (suppressed in output)'
- if mode != 'json':
- print(f'[+] Config check is finished: \'OK\' - {ok_count}{ok_suppressed} / \'FAIL\' - {fail_count}{fail_suppressed}')
+ print(f'[+] Config check is finished: \'OK\' - {ok_count}{ok_suppressed} / \'FAIL\' - {fail_count}{fail_suppressed}')
def parse_kconfig_file(parsed_options, fname):
def parse_kconfig_file(parsed_options, fname):
- with
open(fname, 'r
', encoding='utf-8') as f:
+ with
_open(fname, 'rt
', encoding='utf-8') as f:
opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
@@
-203,11
+209,11
@@
def main():
description='A tool for checking the security hardening options of the Linux kernel')
parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
parser.add_argument('-p', '--print', choices=supported_archs,
description='A tool for checking the security hardening options of the Linux kernel')
parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
parser.add_argument('-p', '--print', choices=supported_archs,
- help='print security hardening
preference
s for the selected architecture')
+ help='print security hardening
option
s for the selected architecture')
parser.add_argument('-c', '--config',
parser.add_argument('-c', '--config',
- help='check
the kernel kconfig file against these preferences
')
+ help='check
security hardening options in the kernel kconfig file (also supports *.gz files)
')
parser.add_argument('-l', '--cmdline',
parser.add_argument('-l', '--cmdline',
- help='check
the kernel cmdline file against these preferences
')
+ help='check
security hardening options in the kernel cmdline file
')
parser.add_argument('-m', '--mode', choices=report_modes,
help='choose the report mode')
args = parser.parse_args()
parser.add_argument('-m', '--mode', choices=report_modes,
help='choose the report mode')
args = parser.parse_args()
@@
-259,14
+265,21
@@
def main():
parsed_kconfig_options = OrderedDict()
parse_kconfig_file(parsed_kconfig_options, args.config)
populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
parsed_kconfig_options = OrderedDict()
parse_kconfig_file(parsed_kconfig_options, args.config)
populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
+
+ # populate the checklist with the kernel version data
populate_with_data(config_checklist, kernel_version, 'version')
if args.cmdline:
populate_with_data(config_checklist, kernel_version, 'version')
if args.cmdline:
- # populate the checklist with the parsed
kconfig
data
+ # populate the checklist with the parsed
cmdline
data
parsed_cmdline_options = OrderedDict()
parse_cmdline_file(parsed_cmdline_options, args.cmdline)
populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
parsed_cmdline_options = OrderedDict()
parse_cmdline_file(parsed_cmdline_options, args.cmdline)
populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
+ # hackish refinement of the CONFIG_ARCH_MMAP_RND_BITS check
+ mmap_rnd_bits_max = parsed_kconfig_options.get('CONFIG_ARCH_MMAP_RND_BITS_MAX', None)
+ if mmap_rnd_bits_max:
+ override_expected_value(config_checklist, 'CONFIG_ARCH_MMAP_RND_BITS', mmap_rnd_bits_max)
+
# now everything is ready, perform the checks
perform_checks(config_checklist)
# now everything is ready, perform the checks
perform_checks(config_checklist)
@@
-291,7
+304,7
@@
def main():
add_kconfig_checks(config_checklist, arch)
add_cmdline_checks(config_checklist, arch)
if mode != 'json':
add_kconfig_checks(config_checklist, arch)
add_cmdline_checks(config_checklist, arch)
if mode != 'json':
- print(f'[+] Printing kernel security hardening
preference
s for {arch}...')
+ print(f'[+] Printing kernel security hardening
option
s for {arch}...')
print_checklist(mode, config_checklist, False)
sys.exit(0)
print_checklist(mode, config_checklist, False)
sys.exit(0)