opensearch-fips

Chainguard Container for opensearch-fips

Minimal image with Opensearch 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/opensearch-fips:latest

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

FIPS Compliance

This image provides a FIPS 140-3 validated Opensearch via the BouncyCastle FIPS provider, which is pre-installed and configured in the image.

Prerequisites

• All passwords must be at least 14 characters (FIPS 112-bit minimum requirement)
• TLS keystores must use BCFKS format (not JKS or PKCS12)
• The BouncyCastle FIPS module path must be configured in Java options

Compatibility Notes

This image does not display the following log messages on startup:

BouncyCastle FIPS library found, setting FIPS JVM options
running in FIPS-140-3 mode

Those messages come from OpenSearch's entrypoint scripts that only check for the existence of bc-fips.jar and dependencies on the classpath. The messages do not accurately represent running OpenSearch with FIPS 140-3 support in a properly configured JVM, with security settings that enforce using the BCFIPS JSSE/JCA provider.

Using OpenSearch FIPS with Helm

Basic Setup

Add the OpenSearch Helm repository:

helm repo add opensearch https://opensearch-project.github.io/helm-charts
helm repo update

FIPS Configuration

Create a values.yaml with the following configuration to enable FIPS-compliant TLS:

singleNode: true

image:
  repository: cgr.dev/ORGANIZATION/opensearch-fips
  tag: latest

# Configure Java with BouncyCastle FIPS module and truststore
opensearchJavaOpts: >-
  -Xmx512M -Xms512M
  --module-path=/usr/share/java/bouncycastle-fips/
  -Djavax.net.ssl.trustStore=/usr/share/opensearch/config/tls/truststore.bcfks
  -Djavax.net.ssl.trustStorePassword=MySecureTruststoreP@ss123

extraEnvs:
  - name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
    value: "MySecureAdminP@ss123"  # Must be 14+ characters
  - name: DISABLE_INSTALL_DEMO_CONFIG
    value: "true"
  - name: KEYSTORE_PASSWORD
    value: "MySecureKeystoreP@ss123"  # Must be 14+ characters

config:
  opensearch.yml: |
    cluster.name: opensearch-cluster
    network.host: 0.0.0.0
    discovery.type: single-node

    # Transport layer TLS with BCFKS
    plugins.security.ssl.transport.enabled: true
    plugins.security.ssl.transport.keystore_type: BCFKS
    plugins.security.ssl.transport.keystore_filepath: tls/keystore.bcfks
    plugins.security.ssl.transport.keystore_password: MySecureKeystoreP@ss123
    plugins.security.ssl.transport.truststore_type: BCFKS
    plugins.security.ssl.transport.truststore_filepath: tls/truststore.bcfks
    plugins.security.ssl.transport.truststore_password: MySecureTruststoreP@ss123

    # HTTP layer TLS with BCFKS
    plugins.security.ssl.http.enabled: true
    plugins.security.ssl.http.keystore_type: BCFKS
    plugins.security.ssl.http.keystore_filepath: tls/keystore.bcfks
    plugins.security.ssl.http.keystore_password: MySecureKeystoreP@ss123
    plugins.security.ssl.http.truststore_type: BCFKS
    plugins.security.ssl.http.truststore_filepath: tls/truststore.bcfks
    plugins.security.ssl.http.truststore_password: MySecureTruststoreP@ss123

    # Security configuration
    plugins.security.allow_default_init_securityindex: true
    plugins.security.authcz.admin_dn:
      - CN=localhost,OU=Test,O=OpenSearch,L=Test,ST=Test,C=US
    plugins.security.nodes_dn:
      - CN=localhost,OU=Test,O=OpenSearch,L=Test,ST=Test,C=US

# Init containers to generate BCFKS keystores
extraInitContainers:
  - name: generate-bcfks-keystores
    image: cgr.dev/ORGANIZATION/opensearch-fips:latest
    env:
      - name: JAVA_TOOL_OPTIONS
        value: "--module-path=/usr/share/java/bouncycastle-fips/"
    command: ["/bin/sh", "-c"]
    args:
      - |
        set -e
        mkdir -p /tls-output

        # Generate keystore with keypair using BCFIPS provider
        keytool -genkeypair \
          -alias opensearch \
          -keyalg RSA \
          -keysize 2048 \
          -validity 365 \
          -dname "CN=localhost,OU=Test,O=OpenSearch,L=Test,ST=Test,C=US" \
          -keystore /tls-output/keystore.bcfks \
          -storetype BCFKS \
          -storepass "MySecureKeystoreP@ss123" \
          -providername BCFIPS

        # Export certificate
        keytool -exportcert \
          -alias opensearch \
          -keystore /tls-output/keystore.bcfks \
          -storetype BCFKS \
          -storepass "MySecureKeystoreP@ss123" \
          -providername BCFIPS \
          -file /tls-output/opensearch.crt

        # Create truststore with certificate
        keytool -importcert \
          -alias opensearch \
          -file /tls-output/opensearch.crt \
          -keystore /tls-output/truststore.bcfks \
          -storetype BCFKS \
          -storepass "MySecureTruststoreP@ss123" \
          -noprompt \
          -providername BCFIPS
    volumeMounts:
      - name: tls-certs
        mountPath: /tls-output

  - name: create-opensearch-keystore
    image: cgr.dev/ORGANIZATION/opensearch-fips:latest
    env:
      - name: OPENSEARCH_JAVA_OPTS
        value: "--module-path=/usr/share/java/bouncycastle-fips/"
    command: ["/bin/sh", "-c"]
    args:
      - |
        set -e
        # Create OpenSearch internal keystore with password
        printf '%s\n%s\n' 'MySecureKeystoreP@ss123' 'MySecureKeystoreP@ss123' | \
          opensearch-keystore create -p
        cp /usr/share/opensearch/config/opensearch.keystore /tls-output/
    volumeMounts:
      - name: tls-certs
        mountPath: /tls-output

extraVolumes:
  - name: tls-certs
    emptyDir: {}

extraVolumeMounts:
  - name: tls-certs
    mountPath: /usr/share/opensearch/config/tls
  - name: tls-certs
    mountPath: /usr/share/opensearch/config/opensearch.keystore
    subPath: opensearch.keystore

Replace ORGANIZATION with your Chainguard organization name and update passwords as needed (keeping them 14+ characters).

Install

helm install opensearch opensearch/opensearch -f values.yaml

Verify FIPS Mode

Once the pod is running, verify HTTPS connectivity:

kubectl exec opensearch-cluster-master-0 -- \
  curl -sf -k -u "admin:admin" 'https://localhost:9200/_cluster/health'

Check the pod logs for BouncyCastle FIPS TLS activity:

kubectl logs opensearch-cluster-master-0 | grep ProvTlsServer

Resources

• OpenSearch Helm Chart
• OpenSearch Security Configuration
• BouncyCastle FIPS

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system 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 development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

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.