import re
import json
from .__about__ import __version__
-from .checks import add_kconfig_checks, add_cmdline_checks, normalize_cmdline_options
+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
def detect_arch(fname, archs):
with _open(fname, 'rt', encoding='utf-8') as f:
- arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
+ arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]+=y$")
arch = None
for line in f.readlines():
if arch_pattern.match(line):
if arch is None:
arch = option
else:
- return None, 'more than one supported microarchitecture is detected'
+ return None, 'detected more than one microarchitecture'
if arch is None:
return None, 'failed to detect microarchitecture'
return arch, 'OK'
def detect_kernel_version(fname):
with _open(fname, 'rt', encoding='utf-8') as f:
- ver_pattern = re.compile("# Linux/.* Kernel Configuration")
+ ver_pattern = re.compile("# Linux/.+ Kernel Configuration$")
for line in f.readlines():
if ver_pattern.match(line):
line = line.strip()
else:
name = opt
value = '' # '' is not None
+ if name in parsed_options:
+ sys.exit(f'[!] ERROR: cmdline option "{name}" exists multiple times')
value = normalize_cmdline_options(name, value)
parsed_options[name] = value
+def parse_sysctl_file(parsed_options, fname):
+ print('parse_sysctl_file: TODO')
+
+
def main():
# Report modes:
# * verbose mode for
help='check the security hardening options in the kernel Kconfig file (also supports *.gz files)')
parser.add_argument('-l', '--cmdline',
help='check the security hardening options in the kernel cmdline file (contents of /proc/cmdline)')
+# parser.add_argument('-s', '--sysctl',
+# help='check the security hardening options in the sysctl output file (`sudo sysctl -a > file`)')
parser.add_argument('-p', '--print', choices=supported_archs,
help='print the security hardening recommendations for the selected microarchitecture')
parser.add_argument('-g', '--generate', choices=supported_archs,
help='generate a Kconfig fragment with the security hardening options for the selected microarchitecture')
args = parser.parse_args()
+ args.sysctl = None # FIXME
mode = None
if args.mode:
print(f'[+] Kconfig file to check: {args.config}')
if args.cmdline:
print(f'[+] Kernel cmdline file to check: {args.cmdline}')
+ if args.sysctl:
+ print(f'[+] Kernel sysctl output file to check: {args.sysctl}')
arch, msg = detect_arch(args.config, supported_archs)
if arch is None:
# add relevant cmdline checks to the checklist
add_cmdline_checks(config_checklist, arch)
+ if args.sysctl:
+ # add relevant sysctl checks to the checklist
+ add_sysctl_checks(config_checklist, arch)
+
# populate the checklist with the parsed Kconfig data
parsed_kconfig_options = OrderedDict()
parse_kconfig_file(parsed_kconfig_options, args.config)
parse_cmdline_file(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()
+ parse_sysctl_file(parsed_sysctl_options, args.sysctl)
+ populate_with_data(config_checklist, parsed_sysctl_options, 'sysctl')
+
# 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:
all_parsed_options = parsed_kconfig_options # assignment does not copy
if args.cmdline:
all_parsed_options.update(parsed_cmdline_options)
+ if args.sysctl:
+ all_parsed_options.update(parsed_sysctl_options)
print_unknown_options(config_checklist, all_parsed_options)
# finally print the results
sys.exit(0)
elif args.cmdline:
- sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking Kconfig')
+ sys.exit('[!] ERROR: checking cmdline depends on checking Kconfig')
+ elif args.sysctl:
+ # TODO: sysctl check should also work separately
+ sys.exit('[!] ERROR: checking sysctl depends on checking Kconfig')
if args.print:
- assert(args.config is None and args.cmdline is None), 'unexpected args'
+ assert(args.config is None and args.cmdline is None and args.sysctl is None), 'unexpected args'
if mode and mode not in ('verbose', 'json'):
sys.exit(f'[!] ERROR: wrong mode "{mode}" for --print')
arch = args.print
add_kconfig_checks(config_checklist, arch)
add_cmdline_checks(config_checklist, arch)
+ add_sysctl_checks(config_checklist, arch)
if mode != 'json':
print(f'[+] Printing kernel security hardening options for {arch}...')
print_checklist(mode, config_checklist, False)
sys.exit(0)
if args.generate:
- assert(args.config is None and args.cmdline is None), 'unexpected args'
+ assert(args.config is None and args.cmdline is None and args.sysctl is None), 'unexpected args'
if mode:
sys.exit(f'[!] ERROR: wrong mode "{mode}" for --generate')
arch = args.generate
add_kconfig_checks(config_checklist, arch)
+ print(f'CONFIG_{arch}=y') # the Kconfig fragment should describe the microarchitecture
for opt in config_checklist:
if opt.name == 'CONFIG_ARCH_MMAP_RND_BITS':
continue # don't add CONFIG_ARCH_MMAP_RND_BITS because its value needs refinement