This application scans container images in an OpenShift release payload, RHEL based nodes, or an operator image for FIPS enabled binaries. The goal is to ensure binaries are compiled correctly for OpenShift.
git clone https://github.com/openshift/check-payload.git cd check-payload make
The binary has a number of built-in configuration files.
A default built-in configuration (config.toml) is used if no options are specified, and no ./config.toml
file is available from the current working directory when running the tool.
A specific configuration from a file can be specified using --config path/to/config.toml
option. Use --config /dev/null
to use an empty configuration.
An additional built-in coniguration tailored for a specific OpenShift version can be specified using -V
, --config-for-version
option, for example -V 4.11
. When this option is specified, the settings from the additional configuration are added to (rather than override) the main configuration (see above). These additional for-version configurations are embedded into the binary during build time from the directories under dist/releases/.
sudo ./check-payload scan payload -V 4.11 \ --url quay.io/openshift-release-dev/ocp-release:4.11.44-x86_64 \ --output-file report.txt
Here
-V
specifies the configuration for a particular OpenShift version;--url
specifies a payload URL;--output-file
specifies a file to write the scan report to.The scan local
subcommand allows you to scan a local unpacked image bundle for FIPS compliance. This is particularly useful for testing or analyzing local images that have been unpacked using tools like umoci
.
To scan a local unpacked image bundle, use the following command:
./check-payload scan local --path /path/to/local/bundle
Here:
--path
specifies the path to the local unpacked image bundle../check-payload scan local --path ./test/resources/mock_unpacked_dir-1
This command will scan the local image bundle located in ./test/resources/mock_unpacked_dir-1
.
This feature is useful for verifying FIPS compliance of container images in a local development environment, without requiring access to podman mount
which is blocked in some pipeline build systems.
sudo ./check-payload scan operator \ --spec registry.ci.openshift.org/ocp-priv/4.11-art-assembly-art6883-3-priv@sha256:138b1b9ae11b0d3b5faafacd1b469ec8c20a234b387ae33cf007441fa5c5d567Scan a node using container image
IMAGE=some.registry.location/check-payload podman run --privileged -ti -v /:/myroot $IMAGE scan node --root /myroot
check-payload
gathers container images from OpenShift release payloads or container images. The scanner can also be used on a RHEL or RHCOS node to scan the root image. A node scan runs within a container with the host OS mounted within it.
Container Image and Payload Scans gather images and emit file paths to the validation logic. This is done by podman
mounting the image to the local machine, walking the directory tree, and emitting the paths for executables to the validation engine.
RHEL or RHCOS nodes can be scanned with check-payload scan node
. To gather the file input paths the scanner queries for all the RPMs on the system and walks the paths within the RPMs finding executables. The list of executable paths are then processed by the validation engine.
flowchart LR subgraph inputs Image --> Scanner Payload --> Scanner Node --> Scanner end Scanner --> Validations Validations --> Printer subgraph results Printer endLoading
The validation engine uses different logic to validate golang and non-golang executables. The scanner only scans for ELF executables.
All scans validate the inclusion of OpenSSL via libcrypto found in /usr/lib64
or /usr/lib
. The OpenSSL library is also validated to include {FIPS_mode, fips_mode, or EVP_default_properties_is_fips_enabled}
.
The rules to scan regular executables are:
Most of RHEL/RHCOS executables are built dynamically to allow for dynamic linking to OpenSSL. There are exceptions for rule (1) which consists of some binaries (ldconfig, build-locale-archive, etc) which are required to be built statically, and/or do not provide cryptographic functionality.
Golang validations run through a pipeline:
JDK validations run through a pipeline:
check-payload
tool is being run on a FIPS enabled hostThe printer aggregates all the results and formats into a table, csv, markdown, etc. If any errors are found then the process exits non-zero. A successful run returns 0.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4