Contact Us 1-800-596-4880

FIPS 140-3 Compliance Support in Government Cloud

Configure Mule runtime engine (Mule) to run in a Federal Information Processing Standard (FIPS) 140-3 certified environment in MuleSoft Government Cloud.

Where the application runs determines what you configure.

Meet FIPS 140-3 Requirements

FIPS 140-3 support in MuleSoft Government Cloud requires:

FIPS 140-3 is the US government security standard that requires compliant parties to use only cryptographic algorithms and techniques certified by NIST.

Review FIPS 140-3 Cipher Suites

FIPS 140-3 mode enables this set of cipher suites. FIPS 140-3 requires TLS 1.3 and TLS 1.2. Earlier TLS versions aren’t supported.

CloudHub enables the set in the runtime image. On a host that you manage, the set is in $MULE_HOME/conf/tls-fips140-3.conf.

TLS 1.3 Cipher Suites

  • TLS_AES_128_GCM_SHA256

  • TLS_AES_256_GCM_SHA384

  • TLS_AES_128_CCM_SHA256

  • TLS_AES_128_CCM_8_SHA256

TLS 1.2 Cipher Suites

  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384

  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384

  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384

  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

Configure FIPS 140-3 for CloudHub

You deploy the application from the Government Cloud control plane. CloudHub runs Mule runtime. Select a FIPS 140-3 runtime image.

Prepare the Application

Before you deploy to a -fips1403 runtime:

  • Update MuleSoft connectors, modules, and extensions to versions that support the FIPS 140-3 runtime. In Anypoint Exchange, use assets tagged fips-140-3-verified.

  • Use FIPS-approved cryptography in custom and partner-built connectors and modules.

  • Convert application keystores and truststores to BCFKS. See Convert Keystores to BCFKS.

Select a FIPS 140-3 Runtime

Deploy or update the application on Mule runtime engine 4.9.17 or later image whose name includes the -fips1403 suffix.

See the CloudHub Runtime Release Notes for the current image for each patch.

Deploy with the Mule Maven Plugin

Set muleVersion to 4.9-java17-fips1403 in the cloudHubDeployment configuration in pom.xml. CloudHub selects the latest patch for that runtime when you deploy.

<cloudHubDeployment>
  <muleVersion>4.9-java17-fips1403</muleVersion>
</cloudHubDeployment>

See Deploy Applications to CloudHub Using the Mule Maven Plugin for the rest of the deployment configuration.

Confirm FIPS 140-3 Is Active

In Runtime Manager, open the application and select the Runtime tab. Runtime version includes the -fips1403 suffix when the application runs on a FIPS 140-3 runtime. For example, 4.9.21:5-fips1403 identifies a FIPS 140-3 runtime.

Review TLS Protocol Support

CloudHub sets TLS 1.2 and TLS 1.3 in the CloudHub runtime image. A CloudHub application uses both protocols. See Review FIPS 140-3 Cipher Suites.

For application TLS contexts, see Configure TLS in Mule.

Configure FIPS 140-3 for Hybrid Standalone and On-Premises

You deploy the application from the Government Cloud control plane. A host that you manage runs Mule runtime for Hybrid Standalone and on-premises deployments. Configure the host for FIPS 140-3 on your schedule.

Use a FIPS license from the license .zip file provided by MuleSoft. The non-FIPS license isn’t valid for FIPS mode.

Move from FIPS 140-2

Apply the differences from a FIPS 140-2 runtime, then install BC-FJA and set wrapper.conf in the procedure on this page.

  • Replace the FIPS 140-2 Bouncy Castle provider (typically 1.x FIPS) with BC-FJA 2.1.2.

  • In wrapper.conf, set mule.security.model to fips140-3. The FIPS 140-2 value is fips140-2.

  • Use $MULE_HOME/conf/tls-fips140-3.conf. Remove references to the FIPS 140-2 TLS configuration file.

  • Remove cipher suites that are FIPS 140-2-only or aren’t FIPS 140-3 compliant. Use the cipher suites in Review FIPS 140-3 Cipher Suites.

  • Convert PKCS12 or JKS keystores and truststores to BCFKS when the application still uses those formats. Set type="bcfks".

  • Use connectors tagged fips-140-3-verified. Remove connectors that are verified only for FIPS 140-2.

  • Restart Mule and confirm in the startup logs that FIPS 140-3 security mode is enabled.

Move from Non-FIPS

Install BC-FJA. Add the wrapper.conf properties. Convert keystores to BCFKS and update each tls:context.

Install BC-FJA

This procedure uses BC-FJA 2.1.2. If you use a different certified security provider, see that provider’s documentation for configuration instructions.

Install and configure BC-FJA with Java 17 or later.

  1. Verify that you are using Java 17 or later and JAVA_HOME is set.

  2. Download the BC-FJA 2.1.2 provider files from the Bouncy Castle website.

  3. Copy the required JAR files to the $MULE_HOME/lib/boot folder:

    bc-fips-2.1.2.jar
    bcutil-fips-2.1.5.jar
    bctls-fips-2.1.22.jar
    bcpkix-fips-2.1.10.jar
  4. Configure the security providers in the $JAVA_HOME/conf/security/java.security file:

    security.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider
    security.provider.2=org.bouncycastle.jsse.provider.BouncyCastleJsseProvider fips:BCFIPS
    security.provider.3=SUN

    On ARM64 (AArch64), keep SUN as security.provider.3. The FIPS provider doesn’t supply the SecureRandom algorithms that the JVM expects on that architecture (NativePRNGBlocking:SUN and DRBG:SUN). The JVM fails during startup, before Mule writes logs, if SUN isn’t registered. This limitation applies to Government Cloud FIPS 140-3 runtimes. See the same note in FIPS 140-3 Compliance Support.

  5. Configure the key manager and trust manager algorithms in the same java.security file:

    ssl.KeyManagerFactory.algorithm=PKIX
    ssl.TrustManagerFactory.algorithm=PKIX

Run Mule in FIPS Security Mode

After you install BC-FJA, configure Mule to run in FIPS 140-3 mode:

  1. Open wrapper.conf in $MULE_HOME/conf.

  2. Add the properties. Replace <n> with the next sequential number in the file:

    # Enable FIPS 140-3 security mode
    wrapper.java.additional.<n>=-Dmule.security.model=fips140-3
    
    # Enable Bouncy Castle approved-only mode
    wrapper.java.additional.<n>=-Dorg.bouncycastle.fips.approved_only=true
    
    # Required for Java 17+ module access
    wrapper.java.additional.<n>=--add-opens=java.base/sun.security.provider=org.bouncycastle.fips.core
    
    # For Mule 4.9.17 or later: set keystore type to BCFKS
    wrapper.java.additional.<n>=-Dmule.keystore.type=BCFKS
  3. In a clustered environment, add the cluster encryption key:

    wrapper.java.additional.<n>=-Dmule.cluster.network.encryption.key={your-encryption-key}
  4. Save your changes and start Mule.

When Mule launches, the startup logs show that FIPS 140-3 security mode is enabled. Mule restricts protocol negotiation to the cipher suites in Review FIPS 140-3 Cipher Suites.

Set TLS Protocols on the Host

To change the TLS protocols or cipher suites, edit $MULE_HOME/conf/tls-fips140-3.conf. Use the cipher suites in Review FIPS 140-3 Cipher Suites.

Convert Keystores to BCFKS

Keystores or truststores in Mule apps are often formatted as PKCS12 or JKS. Convert them to BCFKS for FIPS 140-3.

  1. Download the bc-fips-2.1.2.jar file from the Bouncy Castle website.

  2. Convert a keystore to BCFKS:

BC_FIPS_JAR=${MULE_HOME}/lib/boot/bc-fips-2.1.2.jar  # Replace with a correct path
OLD_KEYSTORE="keystore.jks"               # Replace with the keystore to convert
OLD_PASSWD="changeit"                     # Replace with the keystore password
NEW_KEYSTORE="keystore.bcfks"             # Replace with the new keystore
NEW_PASSWD="changeit"                     # Replace with the new keystore password

keytool -importkeystore \
 -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider \
 -providerpath ${BC_FIPS_JAR} \
 -srckeystore  ${OLD_KEYSTORE}   -srcstoretype JKS       -srcstorepass ${OLD_PASSWD} \
 -destkeystore ${NEW_KEYSTORE}   -deststoretype BCFKS    -deststorepass ${NEW_PASSWD}

If the source keystore is PKCS12, set -srcstoretype to PKCS12 in the keytool command.

  1. Update the TLS configuration in the Mule configuration file to use the new keystore or truststore:

<tls:context>
	<tls:key-store   type="bcfks" path="server.bcfks" password="changeit" keyPassword="changeit" alias="default" />
	<tls:trust-store type="bcfks" path="client.bcfks" password="changeit" />
</tls:context>

Confirm Connector Compliance

Only connectors tagged as fips-140-3-verified in Anypoint Exchange are certified for use in FIPS 140-3 environments. To check compliance in Exchange before deploying:

  1. Open Anypoint Exchange.

  2. Search for the connector.

  3. Check for the fips-140-3-verified tag.

Tips and Limitations

  • Not all encryption schemes and signatures are FIPS 140-3 compliant. If your app uses a non-approved algorithm, you might see a runtime error such as:

    	Could not find encryption algorithm '<algorithm-name>'.
    	You are running in FIPS mode, so please verify that
    	the algorithm is compliant with FIPS.
  • Different environments can have different security configurations. Test before deploying to production.