Chainguard Container for keycloak-operator-fips

A Kubernetes Operator based on the Operator SDK for installing and managing Keycloak with FIPS support.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/keycloak-operator-fips:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

While Chainguard's Keycloak Operator FIPS image is comparable to the official Keycloak Operator on Docker Hub, Chainguard's image is also FIPS 140-3 compliant. Switching to the Chainguard image should not require any changes to your existing setup but you must create compatible (BCFKS) Keystore and use --module-path=/usr/share/java/bouncycastle-fips as JAVA_TOOL_OPTIONS.

FIPS Support

This image contains Bouncy Castle crypto libraries for FIPS.

The FIPS certified version of Bouncy Castle is compliant with the FIPS 140-3 standard when used in accordance with the Bouncy Castle Security Policy.

This image also ships with a validated redistribution of the OpenSSL's FIPS provider module. For more on FIPS support in Chainguard Images, consult the guide on FIPS-enabled Chainguard Images on Chainguard Academy.

Please ensure that --module-path=/usr/share/java/bouncycastle-fips is used at runtime, with such path copied from this image.

Getting Started

1. Install CRDs

Please replace the version with latest release of keycloak at the time of usage.

kubectl apply -f https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/26.2.5/kubernetes/keycloaks.k8s.keycloak.org-v1.yml
kubectl apply -f https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/26.2.5/kubernetes/keycloakrealmimports.k8s.keycloak.org-v1.yml

2. Generate a BCFKS Truststore

You must generate a BCFKS truststore using the FIPS image and signed by a CA and mount it into the operator pod. A sample workflow:

KEYSTORE_PASSWORD="AbCdEfG0!12345678NotReal"
NAMESPACE="keycloak-test"
TMPDIR="$(mktemp -d)"

openssl req -x509 -newkey rsa:2048   -keyout "${TMPDIR}/ca.key"   -out "${TMPDIR}/ca.crt"   -days 365 -nodes   -subj "/CN=localhost/O=KeycloakOperator/C=US"

kubectl run -n "$NAMESPACE" create-bcfks --rm -i --restart=Never   --image=cgr.dev/ORGANIZATION/keycloak-operator-fips:latest   --command -- sh -c "
    cat > /tmp/ca.crt <<EOF
$(cat ${TMPDIR}/ca.crt)
EOF
    keytool -importcert -keystore /tmp/server.bcfks -storetype BCFKS       -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider       -providerpath /usr/share/java/quarkus-app/lib/main/org.bouncycastle.bcprov-jdk18on-1.80.jar       -alias rootca -file /tmp/ca.crt -storepass '${KEYSTORE_PASSWORD}' -noprompt &&     base64 /tmp/server.bcfks" > "${TMPDIR}/server.bcfks.b64"

base64 -d "${TMPDIR}/server.bcfks.b64" > "${TMPDIR}/server.bcfks"

kubectl create secret generic operator-truststore   --from-file=server.bcfks="${TMPDIR}/server.bcfks" -n "$NAMESPACE"

3. Deploy the Keycloak Operator (FIPS)

Example patch for the deployment YAML:

containers:
- name: keycloak-operator
  image: cgr.dev/ORGANIZATION/keycloak-operator-fips:latest
  env:
  - name: JAVA_TOOL_OPTIONS
    value: "--module-path=/usr/share/java/bouncycastle-fips"
  volumeMounts:
  - name: truststore-volume
    mountPath: /mnt
volumes:
- name: truststore-volume
  secret:
    secretName: operator-truststore

kubectl apply -f keycloak-operator-fips-deployment.yaml

Additional Resources

• Keycloak Operator Documentation
• FIPS-enabled Containers Guide
• BouncyCastle FIPS Docs

What are Chainguard Containers?

Chainguard Containers are minimal container images that are secure by default.

In many cases, the Chainguard Containers tagged as :latest contain only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager. Chainguard Containers are built with Wolfi, our Linux undistro designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a -dev variant.

Although the -dev container image variants have similar security features as their more minimal versions, they feature additional software that is typically not necessary in production environments. We recommend using multi-stage builds to leverage the -dev variants, copying application artifacts into a final minimal container that offers a reduced attack surface that won’t allow package installations or logins.

Learn More

To better understand how to work with Chainguard Containers, please visit Chainguard Academy and Chainguard Courses.

In addition to Containers, Chainguard offers VMs and Libraries. Contact Chainguard to access additional products.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.