X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=kernel_hardening_checker%2F__init__.py;h=67e02690bee12aa8b6934f5ec3c7ee91cab044c0;hb=20c636e47eaabf1cc40aad99d3138ffbb0a27f2f;hp=6da5feb0436c7ce0ffb86d652b3568f429892e24;hpb=0ed34de2f29e5135e81e3622916dffdb179e7f83;p=kconfig-hardened-check.git diff --git a/kernel_hardening_checker/__init__.py b/kernel_hardening_checker/__init__.py index 6da5feb..67e0269 100644 --- a/kernel_hardening_checker/__init__.py +++ b/kernel_hardening_checker/__init__.py @@ -8,28 +8,35 @@ Author: Alexander Popov 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,too-many-branches,too-many-statements +import os import gzip import sys from argparse import ArgumentParser -from collections import OrderedDict -from typing import List, Tuple, OrderedDict, TextIO +from typing import List, Tuple, Dict, TextIO import re import json -from .__about__ import __version__ from .checks import add_kconfig_checks, add_cmdline_checks, normalize_cmdline_options, add_sysctl_checks -from .engine import populate_with_data, perform_checks, override_expected_value +from .engine import StrOrNone, TupleOrNone, ChecklistObjType +from .engine import print_unknown_options, populate_with_data, perform_checks, override_expected_value -def _open(file: str, *args, **kwargs) -> TextIO: - if file.endswith('.gz'): - return gzip.open(file, *args, **kwargs) - return open(file, *args, **kwargs) +# kernel-hardening-checker version +__version__ = '0.6.6' -def detect_arch(fname: str, archs: List[str]) -> Tuple[str | None, str]: - with _open(fname, 'rt', encoding='utf-8') as f: +def _open(file: str) -> TextIO: + try: + if file.endswith('.gz'): + return gzip.open(file, 'rt', encoding='utf-8') + return open(file, 'rt', encoding='utf-8') + except FileNotFoundError: + sys.exit(f'[!] ERROR: unable to open {file}, are you sure it exists?') + + +def detect_arch(fname: str, archs: List[str]) -> Tuple[StrOrNone, str]: + with _open(fname) as f: arch_pattern = re.compile(r"CONFIG_[a-zA-Z0-9_]+=y$") arch = None for line in f.readlines(): @@ -45,8 +52,8 @@ def detect_arch(fname: str, archs: List[str]) -> Tuple[str | None, str]: return arch, 'OK' -def detect_kernel_version(fname: str) -> Tuple[Tuple | None, str]: - with _open(fname, 'rt', encoding='utf-8') as f: +def detect_kernel_version(fname: str) -> Tuple[TupleOrNone, str]: + with _open(fname) as f: ver_pattern = re.compile(r"^# Linux/.+ Kernel Configuration$|^Linux version .+") for line in f.readlines(): if ver_pattern.match(line): @@ -55,17 +62,17 @@ def detect_kernel_version(fname: str) -> Tuple[Tuple | None, str]: ver_str = parts[2].split('-', 1)[0] ver_numbers = ver_str.split('.') if len(ver_numbers) >= 3: - if all(map(lambda x: x.isdigit(), ver_numbers)): + if all(map(lambda x: x.isdecimal(), ver_numbers)): return tuple(map(int, ver_numbers)), 'OK' msg = f'failed to parse the version "{parts[2]}"' return None, msg return None, 'no kernel version detected' -def detect_compiler(fname: str) -> Tuple[str | None, str]: +def detect_compiler(fname: str) -> Tuple[StrOrNone, str]: gcc_version = None clang_version = None - with _open(fname, 'rt', encoding='utf-8') as f: + with _open(fname) as f: for line in f.readlines(): if line.startswith('CONFIG_GCC_VERSION='): gcc_version = line[19:-1] @@ -80,30 +87,7 @@ def detect_compiler(fname: str) -> Tuple[str | None, str]: sys.exit(f'[!] ERROR: invalid GCC_VERSION and CLANG_VERSION: {gcc_version} {clang_version}') -def print_unknown_options(checklist: List, parsed_options: OrderedDict, opt_type: str) -> None: - known_options = [] - - for o1 in checklist: - if o1.opt_type != 'complex': - known_options.append(o1.name) - continue - for o2 in o1.opts: - if o2.opt_type != 'complex': - if hasattr(o2, 'name'): - known_options.append(o2.name) - continue - for o3 in o2.opts: - assert(o3.opt_type != 'complex'), \ - f'unexpected ComplexOptCheck inside {o2.name}' - if hasattr(o3, 'name'): - known_options.append(o3.name) - - for option, value in parsed_options.items(): - if option not in known_options: - print(f'[?] No check for {opt_type} option {option} ({value})') - - -def print_checklist(mode: str | None, checklist: List, with_results: bool) -> None: +def print_checklist(mode: StrOrNone, checklist: List[ChecklistObjType], with_results: bool) -> None: if mode == 'json': output = [] for opt in checklist: @@ -123,14 +107,21 @@ def print_checklist(mode: str | None, checklist: List, with_results: bool) -> No print('=' * sep_line_len) # table contents + ok_count = 0 + fail_count = 0 for opt in checklist: if with_results: - if mode == 'show_ok': - if not opt.result.startswith('OK'): + assert(opt.result), f'unexpected empty result of {opt.name} check' + if opt.result.startswith('OK'): + ok_count += 1 + if mode == 'show_fail': continue - if mode == 'show_fail': - if not opt.result.startswith('FAIL'): + elif opt.result.startswith('FAIL'): + fail_count += 1 + if mode == 'show_ok': continue + else: + assert(False), f'unexpected result "{opt.result}" of {opt.name} check' opt.table_print(mode, with_results) print() if mode == 'verbose': @@ -139,9 +130,7 @@ def print_checklist(mode: str | None, checklist: List, with_results: bool) -> No # final score if with_results: - fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist))) fail_suppressed = '' - ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist))) ok_suppressed = '' if mode == 'show_ok': fail_suppressed = ' (suppressed in output)' @@ -150,8 +139,8 @@ def print_checklist(mode: str | None, checklist: List, with_results: bool) -> No print(f'[+] Config check is finished: \'OK\' - {ok_count}{ok_suppressed} / \'FAIL\' - {fail_count}{fail_suppressed}') -def parse_kconfig_file(_mode: str | None, parsed_options: OrderedDict, fname: str) -> None: - with _open(fname, 'rt', encoding='utf-8') as f: +def parse_kconfig_file(_mode: StrOrNone, parsed_options: Dict[str, str], fname: str) -> None: + with _open(fname) as f: opt_is_on = re.compile(r"CONFIG_[a-zA-Z0-9_]+=.+$") opt_is_off = re.compile(r"# CONFIG_[a-zA-Z0-9_]+ is not set$") @@ -175,10 +164,14 @@ def parse_kconfig_file(_mode: str | None, parsed_options: OrderedDict, fname: st sys.exit(f'[!] ERROR: Kconfig option "{line}" is found multiple times') if option: + assert(value), f'unexpected empty value for {option}' parsed_options[option] = value -def parse_cmdline_file(mode: str | None, parsed_options: OrderedDict, fname: str) -> None: +def parse_cmdline_file(mode: StrOrNone, parsed_options: Dict[str, str], fname: str) -> None: + if not os.path.isfile(fname): + sys.exit(f'[!] ERROR: unable to open {fname}, are you sure it exists?') + with open(fname, 'r', encoding='utf-8') as f: line = f.readline() opts = line.split() @@ -196,10 +189,14 @@ def parse_cmdline_file(mode: str | None, parsed_options: OrderedDict, fname: str if name in parsed_options and mode != 'json': print(f'[!] WARNING: cmdline option "{name}" is found multiple times') value = normalize_cmdline_options(name, value) + assert(value is not None), f'unexpected None value for {name}' parsed_options[name] = value -def parse_sysctl_file(mode: str | None, parsed_options: OrderedDict, fname: str) -> None: +def parse_sysctl_file(mode: StrOrNone, parsed_options: Dict[str, str], fname: str) -> None: + if not os.path.isfile(fname): + sys.exit(f'[!] ERROR: unable to open {fname}, are you sure it exists?') + with open(fname, 'r', encoding='utf-8') as f: sysctl_pattern = re.compile(r"[a-zA-Z0-9/\._-]+ =.*$") for line in f.readlines(): @@ -255,7 +252,7 @@ def main() -> None: if mode != 'json': print(f'[+] Special report mode: {mode}') - config_checklist = [] # type: List + config_checklist = [] # type: List[ChecklistObjType] if args.config: if args.print: @@ -306,7 +303,7 @@ def main() -> None: add_sysctl_checks(config_checklist, arch) # populate the checklist with the parsed Kconfig data - parsed_kconfig_options = OrderedDict() # type: OrderedDict + parsed_kconfig_options = {} # type: Dict[str, str] parse_kconfig_file(mode, parsed_kconfig_options, args.config) populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig') @@ -315,13 +312,13 @@ def main() -> None: if args.cmdline: # populate the checklist with the parsed cmdline data - parsed_cmdline_options = OrderedDict() # type: OrderedDict + parsed_cmdline_options = {} # type: Dict[str, str] parse_cmdline_file(mode, parsed_cmdline_options, args.cmdline) populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline') if args.sysctl: # populate the checklist with the parsed sysctl data - parsed_sysctl_options = OrderedDict() # type: OrderedDict + parsed_sysctl_options = {} # type: Dict[str, str] parse_sysctl_file(mode, parsed_sysctl_options, args.sysctl) populate_with_data(config_checklist, parsed_sysctl_options, 'sysctl') @@ -366,7 +363,7 @@ def main() -> None: add_sysctl_checks(config_checklist, None) # populate the checklist with the parsed sysctl data - parsed_sysctl_options = OrderedDict() + parsed_sysctl_options = {} parse_sysctl_file(mode, parsed_sysctl_options, args.sysctl) populate_with_data(config_checklist, parsed_sysctl_options, 'sysctl') @@ -388,7 +385,7 @@ def main() -> None: if mode and mode not in ('verbose', 'json'): sys.exit(f'[!] ERROR: wrong mode "{mode}" for --print') arch = args.print - assert arch, 'unexpected empty arch from ArgumentParser' + assert(arch), 'unexpected empty arch from ArgumentParser' add_kconfig_checks(config_checklist, arch) add_cmdline_checks(config_checklist, arch) add_sysctl_checks(config_checklist, arch) @@ -398,11 +395,15 @@ def main() -> None: sys.exit(0) if args.generate: - assert(args.config is None and args.cmdline is None and args.sysctl is None and args.print is None), 'unexpected args' + assert(args.config is None and + args.cmdline is None and + args.sysctl is None and + args.print is None), \ + 'unexpected args' if mode: sys.exit(f'[!] ERROR: wrong mode "{mode}" for --generate') arch = args.generate - assert arch, 'unexpected empty arch from ArgumentParser' + assert(arch), 'unexpected empty arch from ArgumentParser' add_kconfig_checks(config_checklist, arch) print(f'CONFIG_{arch}=y') # the Kconfig fragment should describe the microarchitecture for opt in config_checklist: