Skip to content

Conversation

@kvakvs
Copy link
Collaborator

@kvakvs kvakvs commented Oct 21, 2025

Fixes #9520

Problem

crypto:supports/0 is currently undocumented but i will add a doc string to it.
Crypto returns some algorithms which are indirectly forbidden under FIPS (i.e. listed as available but not working).

The Expectation

Expected: All algorithms returned by crypto:supports/0 will be available at least in one way.
Bonus points for returning forbidden algorithm names separately so that the users will not complain that something "has disappeared" and will see the reason.

Solution

The call to crypto:supports/0 under FIPS build with fips=enabled in crypto app settings, will filter the algorithms by their availability in a much more strict way (by actually trying to initialize each algorithm and recording the failures as a sign of unavailability) and will return an additional section in the results containing disabled algorithms:

[{hashs,[...
 {ciphers, ...
 {kems,[]},
 {public_keys, ...
 {macs, ...
 {curves, ...
 {rsa_opts, ...
 {fips_forbidden,[{hashs,[blake2s,blake2b,sm3,ripemd160,md5,
                          md4]},
                  {ciphers,[chacha20,sm4_ctr,sm4_ofb,sm4_cfb,sm4_ecb,sm4_cbc,
                            blowfish_ecb,blowfish_ofb64,blowfish_cfb64,blowfish_cbc,
                            des_ede3_cfb,des_ecb,des_cfb,des_cbc,rc4|...]},
                  {kems,[mlkem1024,mlkem768,mlkem512]},
                  {public_keys,[srp,eddh,eddsa,ecdh,ecdsa,ec_gf2m,dss]},
                  {macs,[hmac,poly1305]},
                  {curves,[secp256r1]},
                  {rsa_opts,[]}]}]

Note this will only appear if FIPS is enabled. And this will only appear if SSL API is 3.0 or later.
The behaviour with FIPS disabled or older SSL will remain unchanged.

TO DO

  • Update documentation for set_fips_mode (deprecated) that it is not thread safe
  • Review "fips=yes" usage in availability tests?
  • Ensure that cached flags for algorithm availability are used/recalculated correctly if fips is toggled in runtime
  • Ensure works with SSL 3 | SSL before 3 | FIPS | NO FIPS

@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2025

CT Test Results

  2 files   14 suites   5m 53s ⏱️
190 tests 165 ✅  25 💤 0 ❌
478 runs  284 ✅ 194 💤 0 ❌

Results for commit d3196a0.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

@kvakvs kvakvs added the team:PS Assigned to OTP team PS label Oct 21, 2025
@kvakvs kvakvs force-pushed the 9520-fips-hide-algorithms branch 3 times, most recently from 4fd908c to 65f3f3d Compare October 23, 2025 13:26
@kvakvs kvakvs changed the base branch from master to maint October 23, 2025 13:55
@kvakvs kvakvs force-pushed the 9520-fips-hide-algorithms branch from cd85ef1 to 0c6bd7f Compare October 23, 2025 13:57
fips_forbidden_* impl for digests
fips_forbidden_* impl for public keys
fips_forbidden_* impl for ciphers
fips_forbidden_* impl for MACs
fips_forbidden_* impl for KEM
fips_forbidden_* impl for curves
Use stdint/stdbool types already available
FIPS doc page updated
@kvakvs kvakvs force-pushed the 9520-fips-hide-algorithms branch from 0c6bd7f to aa72b5e Compare October 23, 2025 13:58
Copy link
Contributor

@sverker sverker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some testing, and it seems like
EVP_MD_fetch(NULL, p->str_v3, "fips=yes") // if supported with FIPS enabled
EVP_MD_fetch(NULL, p->str_v3, "fips=no") // if supported with FIPS disabled
EVP_MD_fetch(NULL, p->str_v3, "") // if supported in current mode set by EVP_default_properties_enable_fips()

Comment on lines 63 to 66
static bool IS_PUBKEY_FORBIDDEN_IN_FIPS(const struct pkey_availability_t* p) {
return p->flags == FIPS_FORBIDDEN_PKEY_ALL
|| p->flags == FIPS_PKEY_NOT_AVAIL;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a difference between FIPS_PKEY_NOT_AVAIL and FIPS_FORBIDDEN_PKEY_ALL?

Comment on lines 277 to 285
EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_name(NULL, str_v3, "fips=yes");
/* failed: algorithm not available, do not add */
if (ctx) {
if (EVP_PKEY_keygen_init(ctx) <= 0) { /* can't generate keys */
unavailable |= FIPS_FORBIDDEN_PKEY_KEYGEN;
}
EVP_PKEY_CTX_free(ctx);

ctx = EVP_PKEY_CTX_new_from_name(NULL, str_v3, NULL);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why "fips=yes" in one place but not the other.

Comment on lines 480 to 486
static size_t curves_lazy_init(ErlNifEnv* env, const bool fips_enabled) {
size_t result = 0;
if (algo_curve.count >= 0) return algo_curve.count;

enif_mutex_lock(algo_curve.mtx_init_curve_types);
if (algo_curve.count < 0) {
init_curves(env, fips_enabled); /* also updates algo_curve.count[0] or [1] */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why pass fips_enabled to init_curves? We only have one array of curves initialized once here. And fips mode can be switched on/off in runtime with crypto:enable_fips_mode/1 (discouraged but used by our tests).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team:PS Assigned to OTP team PS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FIPS 140-3 vs supported algorithms in ssh

2 participants