Support for FIPS compliance mode

[beanuwave]

Description

This PR makes FIPS mode available through the OPENSEARCH_CRYPTO_STANDARD=FIPS-140-3 environmental parameter instead of the tests.fips.enabled setting. It provides FIPS 140-3 support by replacing all BC dependencies with BCFIPS dependencies and making FIPS approved-only mode configurable at launch. Running this mode restricts the BCFIPS provider to rely solely on FIPS-certified ciphers.

• The fips.gradle build script is removed in order to support a single-build solution.
• All BC dependencies are replaced by BCFIPS.
• Fixed creation of password protected internal keystore for valuable settings at node start. The add-string command was made with additional --stdin option, which interferes with password input.
• The Password Matcher inside Identity-Shiro that relies on BC to check if hashed passwords match with OpenBSDBCrypt is replaced by the password4j implementation.
• Adds full support for the BCFKS format (*.bcfks) for key and trust stores, also making it the default.
• KeyStore instantiation was added to forbidden-apis in favour of KeyStoreFactory.
• Google's truststore is converted to the BCFKS format.
• Makes the best guess of which store type is provided based on the filename extension.
• Store types are strictly limited to JKS, PKCS12, PKCS11, and BCFKS.
• Refactors PemUtils to parse private keys in formats EC, PKCS8, PKCS1, and DSA, with or without encryption, and with or without parameters.
• dependency ':libs:opensearch-common' was added to rest-client build, to support strict keystore types. It's also the reason for JVM bump JAVA8 to JAVA11.
• allow ingest-attachment plugin to run in FIPS mode, since BC dependencies find no use.
• The java.security file is added to the build to distinguish between FIPS and non-FIPS environments.
• The fips_java.security file is altered due to evolving security standards.
• The security.policy file is altered to grant necessary security permissions.
• Increased security standards in KeyTabs and algorithms for Kerberos.
• SecureRandom gets instantiated in to different way, depending on if it runs with FIPS or not.
• Uninstalls SunJCE provider from security providers list at runtime when FIPS mode is enabled.

Runtime limitations (known so far) that come with enabling FIPS mode:

Admins can continue to manage their systems without being impacted by this change. However, for those keen on FIPS compliance, the most common obstacle will likely be the requirement to set a stronger password for the internal keystore and also convert key and truststores to *.bcfks format.

• Does not allow empty passwords for keystores or private keys (they need to be at least 112 bits in strength).
• The ssl.verification_mode=NONE setting is not permitted.
• JKS and PKCS12 key and trust store types are not supported at all.
• The internal keystore cannot be auto-migrated from versions 1 or 2.
• Azure Classic Discovery plugin -> deprecated.
• SQL-CLI client.
• HDFS plugin won't connect since it's using RC4 cipher for token authentication.

Reasons for refactoring PemUtils, which is used by the Reindex API in cases of migrating data from a remote cluster that is TLS protected:

• Lack of support for evolving standards like PKCS#8.
• Password-Based Key Derivation Functions such as PBKDF-OPENSSL are not supported in FIPS mode in favor of the PBKDF2 standard.
• Java type safety.
• It is generally a good idea to let ASN1 annotation parsing be done by external security libraries.

Related Issues

opensearch-project/security#3420

Check List

• Functionality includes testing.
• API changes companion pull request created, if applicable.
• Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

❌ Gradle check result for 6016d5d: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 8e8ed47: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 6016d5d: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[dblock]

Could use some help maybe from @cwperks or @peternied reviewing this, please.

[beanuwave]

@reta I’m sorry for being ambiguous about the meaning of Default mode. In this mode, non-approved algorithms are used, which makes it non-compliant. This feature of BC libraries allows threads with strict security requirements to run in an isolated state using only certified algorithms, while other threads without security constraints can run without that isolation. In this PR however, we do not separate the security level thread-by-thread; we apply it application-wide. Therefore, depending on whether the FIPS environment variable is set, OpenSearch will run entirely in either Default or ApprovedOnly mode.

Generally speaking, I would argue that the non-FIPS BC libraries perform the same functionality for this project as the BC-FIPS libraries when used in Default mode, since the test suite passes and manual compatibility checks have been conducted. So far, the only known limitation is the incompatibility with the OpenSAML.

Additionally, the BC security provider follows the JCA/JCE strategy, where multiple providers can be active simultaneously, offering the same (not identical) functionality through the engine implementations.

I hope this clarifies why simply having BC-FIPS libraries on the classpath does not, by itself, mean that the application is FIPS-compliant. Our goal is to provide a single deployment solution that includes a pre-runtime toggle for FIPS mode, with minimal impact on the feature set—so that end users uninterested in FIPS remain unaffected. Therefore, the intension is to support two modes:

• Non-FIPS (with BCFIPS + SunJCE security providers)
• FIPS-140-3 (with BCFIPS in approved-only mode)

If it makes sense to encapsulate BC class usage further, I’m happy to consider that.

[reta]

Thanks a lot for clarification @beanuwave , it makes now clear that with

• Non-FIPS (with BCFIPS + SunJCE security providers)
• FIPS-140-3 (with BCFIPS in approved-only mode)

BC is by design and is mandatory dependency. The impact of that - the BCFIPS dependencies are going to leak into (mostly) every single project in the ecosystem (through clients, build tooling or core itself), no matter if BC/FIPS is on their agenda or not. It looks to me quite disruptive.

[beanuwave]

@reta the BCFIPS dependencies are going to leak into (mostly) every single project in the ecosystem (through clients, build tooling or core itself), no matter if BC/FIPS is on their agenda or not

I agree—the BC libraries are essentially everywhere at this point, since they're our primary security provider. Reducing their footprint hasn’t been on our agenda so far, but if you have any suggestions, I’m happy to consider them.

[reta]

I agree—the BC libraries are essentially everywhere at this point, since they're our primary security provider. Reducing their footprint hasn’t been on our agenda so far, but if you have any suggestions, I’m happy to consider them.

I think if we take a premise that FIPS is not required BUT just one of the favors of the distribution (hardened one), than we could make it truly optional, some suggestions on this pull requests are towards this goal.

[github-actions]

❌ Gradle check result for 6a0e42f: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❕ Gradle check result for 951e66d: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[github-actions]

❌ Gradle check result for af76585: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

✅ Gradle check result for 20a3362: SUCCESS