Chainguard Container for keycloak-bitnami-fips

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-bitnami-fips:latest

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

FIPS

This FIPS-compliant Bitnami Keycloak image is a drop-in replacement for the upstream Bitnami Keycloak image. It is intended for deployments that require FIPS compliance.

We had to pass some extra environment variables to image config to enforce FIPS mode:

• $KEYCLOAK_EXTRA_ARGS=--features=fips --fips-mode=strict
• $JDK_JAVA_OPTIONS=-Djavax.net.ssl.trustStoreType=FIPS

Prerequisites

• DB connection password must be at least 112 bits.
• A keystore file must be provided to enable FIPS mode.
• Keystore password must be at least 112 bits.

Disclaimer

This image is equipped with the essential components for Keycloak to operate in FIPS mode. However, it's important for users to ensure they use it in line with FIPS compliance standards.

This includes tasks such as keystore generation, configuration, and launching Keycloak with the correct configuration parameters. More guidance is provided in the sections below.

Keystore

Keycloak requires a bcfips-compatible keystore to manage its SSL/TLS certificates.

Although Keycloak supports various keystore types, only BCKFS offers the capability to operate in approved (strict) mode under FIPS standards, ensuring only approved ciphers are used.

BCKFS Keystore creation

To create keystore you can use keytool from this image like so:

kubectl run -q --rm --attach create-keystore \
  --image=cgr.dev/ORGANIZATION/keycloak-bitnami-fips --restart=Never --command -- \
    sh -c ' \
      keytool -v -keystore "/tmp/server.keystore" \
      -storetype bcfks \
      -providername BCFIPS \
      -alias "localhost" \
      -genkeypair -sigalg SHA512withRSA -keyalg RSA \
      -dname CN="localhost" \
      -storepass "<YOUR TLS KEYSTORE PASSWORD>" \
      -keypass "<YOUR TLS KEY PASSWORD, can be the same>"; \
      cat /tmp/server.keystore' > server.keystore

BCKFS Truststore creation

To create a truststore and import and trust an existing CA certifcate you can also use keytool:

docker run -v $(pwd):/tmp/keystore --entrypoint keytool cgr.dev/ORGANIZATION/keycloak-fips \
  -v -keystore /tmp/keystore/truststore.bckfs \
  -storetype bcfks \
  -providername BCFIPS \
  -import -file /tmp/keystore/MyCA.crt \
  -storepass "<YOUR TRUSTSTORE PASSWORD>" \
  -trustcacerts \
  -noprompt

You can similarly use the keycloak container as an init container in your helm values.yaml to import certificates to a BCKFS truststore. When doing this you may need to set the environment of just the init containerJAVA_TOOL_OPTS to set the --module-path init container and configure the truststore for keycloak using the javax.net.ssl properties using JAVA_OPTS. The need for JAVA_TOOL_OPTIONS for Java tooling with the BCFIPS provider is documented in section 2.1.1 in the Bouncy Castle FIPS Java API User Guide:

extraEnvVars:
- name: JAVA_OPTS
  value: "-Djavax.net.ssl.trustStore=/opt/bitnami/keycloak/certs/keycloak.truststore.jks -Djavax.net.ssl.trustStorePassword=changeit -Djavax.net.ssl.trustStoreType=FIPS"
  env:
  - name: JAVA_TOOL_OPTIONS
    value: "--module-path=/usr/share/java/bouncycastle-fips -Djava.class.path=/usr/share/java/bouncycastle-fips/bc-fips.jar"

** Note on --truststore-paths **

Currently it is not possible to use the --truststore-paths option when using --features=fips --fips-mode=strict, see this issue

Deployment (Kubernetes)

To deploy Keycloak (Bitnami FIPS) on Kubernetes, you can follow the official Bitnami documentation and also KeyCloak FIPS documentation.

You will need to do all of the prerequisites mentioned above, and then you need to pass the necessary values to the Helm chart.

Once you create your server.keystore using the BCFIPS provider, create a Secret object in your Kubernetes cluster to mount it into the Keycloak container later on:

kubectl create secret generic keycloak-keystore --from-file=server.keystore

Set the values to override the necessary fields:

cat <<EOF > keycloak_values.yaml
extraVolumes:
  - name: "keycloak-keystore"
    secret:
      secretName: "keycloak-keystore"
      items:
        - key: "server.keystore"
          path: "server.keystore"
extraVolumeMounts:
  - name: "keycloak-keystore"
    mountPath: "/usr/share/java/keycloak/conf"
    readOnly: true
auth:
  adminUser: "<ADMIN_USER>"
  adminPassword: "<ADMIN_PASSWORD>"
image:
  registry: cgr.dev
  repository: ORGANIZATION/keycloak-bitnami-fips
  tag: latest
extraStartupArgs: "--features=fips --fips-mode=strict --https-key-store-password=<KEYSTORE_PASSWORD>"
# If using the chart's postgres, set a long password
postgresql:
  auth:
    password: <LONG_DATABASE_PASSWORD>
EOF

Then run the following Helm command to deploy:

helm install keycloak oci://registry-1.docker.io/bitnamicharts/keycloak \
  --namespace keycloak \
  --create-namespace \
  --values keycloak_values.yaml

FIPS validation

If you want to validate the FIPS mode as we did in image tests, you can increase the log level to TRACE. You'll see debug logs such as the below if Keycloak is running in FIPS mode:

--log-level='INFO,org.keycloak.common.crypto:TRACE,org.keycloak.crypto:TRACE'

Then you will see the following logs:

trustStoreType: FIPS
FIPS-JVM: enabled
Approved Mode
BouncyCastleFipsProvider

Debugging

Invalid Keystore Format with BCFKS in production mode

Error Message:

# kc.sh start --features=fips --hostname=localhost --https-key-store-password='**********'
ERROR: Failed to start server in (production) mode
ERROR: Unable to start HTTP server
ERROR: java.io.IOException: Invalid keystore format

Solution: BCFKS Keystores default to strict mode, and it's likely you omitted --fips-mode=strict in your arguments. If you wish to run in non-strict mode with BCFKS, you need to include --https-key-store-type=bcfks.

This is called out in the official documentation, but perhaps could benefit from additional clarification.

Keystore corrupted error upon launch

Error Message:

ERROR: Unable to start HTTP server
ERROR: java.io.IOException: BCFKS KeyStore corrupted: MAC calculation failed.
ERROR: BCFKS KeyStore corrupted: MAC calculation failed.

Solution: The error indicates that a Keystore was detected, but there was an issue parsing it. Usually this means that the password used to create the keystore does not match what was provided as the --https-key-store-password argument to Keycloak.

Key material not provided error in production mode

Error Message:

ERROR: Failed to start server in (production) mode
ERROR: Key material not provided to setup HTTPS. Please configure your
keys/certificates or start the server in development mode.

Solution: This error usually indicates that a .keystore was not detected in the /usr/share/java/keycloak/conf directory. Ensure you have created a Keystore and it is accessible to the container in the expected directory.

Password must be at least 112 bits

Error Message:

Failed to add user '<admin-user>' to realm 'master': org.keycloak.models.ModelException:
password must be at least 112 bits
FipsUnapprovedOperationError: password must be at least 112 bits

Solution: This is expected whenever Keycloak is running in strict (approved) mode for FIPS. Choose a longer admin password which is compliant. Refer to the Keycloak FIPS documentation for more information.

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.