1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
#!/usr/bin/env python3
# Copyright 2024 Red Hat Inc., Durham, North Carolina.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import argparse
import subprocess
import sys
import tempfile
from pathlib import Path
def parse_args():
parser = argparse.ArgumentParser(
description="Use in your Containerfile to build hardened bootable "
"container images. Performs OpenSCAP scan and remediation of the "
"image.")
parser.add_argument(
"--profile",
help="ID of the profile to be evaluated")
parser.add_argument(
"--tailoring-file",
help="Use given XCCDF Tailoring file")
parser.add_argument(
"--tailoring-id", metavar="COMPONENT_ID",
help="Use given DS component as XCCDF Tailoring file")
parser.add_argument(
"--results-arf",
help="Write ARF (result data stream) into file")
parser.add_argument(
"--report",
help="Write HTML report into file")
parser.add_argument(
"data_stream", metavar="DATA_STREAM",
help="Path to a SCAP source data stream, eg. "
"/usr/share/xml/scap/ssg/content/ssg-rhel10-ds.xml")
parser.add_argument(
"--fetch-remote-resources", action="store_true",
help="Fetch remote resources referenced in the XCCDF content")
# Unfortunately, we can't add "--rule", "--skip-rule", or "--reference"
# because the "oscap xccdf generate fix" submodule doesn't support these
# options.
return parser.parse_args()
def verify_bootc_build_env():
rv = subprocess.run(
["rpm", "-q", "bootc"],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
bootc_env = (rv.returncode == 0)
container_env = Path("/run/.containerenv").exists()
if not bootc_env or not container_env:
raise RuntimeError(
"This script is supposed to be used only in the bootable "
"container build environment.")
def install_sce_dependencies():
required_packages = [
"openscap-engine-sce",
"setools-console" # seinfo is used by the sebool template
]
install_cmd = ["dnf", "-y", "install"] + required_packages
install_process = subprocess.run(
install_cmd, universal_newlines=True,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
if install_process.returncode != 0:
raise RuntimeError(
f"{install_process.stdout}\nFailed to install SCE dependencies.")
def add_args(option_args_list, cmd):
for o, a in option_args_list:
if a:
cmd.append(o)
cmd.append(a)
def add_common_args(args, cmd):
oal = [
("--profile", args.profile),
("--tailoring-file", args.tailoring_file),
("--tailoring-id", args.tailoring_id)
]
add_args(oal, cmd)
if args.fetch_remote_resources:
cmd.append("--fetch-remote-resources")
def add_eval_args(args, cmd):
oal = [
("--results-arf", args.results_arf),
("--report", args.report),
]
add_args(oal, cmd)
def pre_scan_fix(args):
with tempfile.NamedTemporaryFile(delete=False) as remediation_script:
gen_fix_cmd = [
"oscap", "xccdf", "generate", "fix", "--fix-type", "bootc",
"--output", remediation_script.name]
add_common_args(args, gen_fix_cmd)
gen_fix_cmd.append(args.data_stream)
subprocess.run(gen_fix_cmd, check=True)
subprocess.run(["bash", remediation_script.name], check=True)
def scan_and_remediate(args):
oscap_cmd = ["oscap", "xccdf", "eval", "--progress", "--remediate"]
add_common_args(args, oscap_cmd)
add_eval_args(args, oscap_cmd)
oscap_cmd.append(args.data_stream)
env = {"OSCAP_PREFERRED_ENGINE": "SCE", "OSCAP_BOOTC_BUILD": "YES"}
try:
subprocess.run(oscap_cmd, env=env, check=True)
except subprocess.CalledProcessError as e:
if e.returncode not in [0, 2]:
print(e, file=sys.stderr)
def main():
args = parse_args()
verify_bootc_build_env()
install_sce_dependencies()
pre_scan_fix(args)
scan_and_remediate(args)
if __name__ == "__main__":
main()
|