NAME¶

OSSL_PROVIDER-FIPS - OpenSSL FIPS provider

DESCRIPTION¶

The OpenSSL FIPS provider is a special provider that conforms to the Federal Information Processing Standards (FIPS) specified in FIPS 140-3. This 'module' contains an approved set of cryptographic algorithms that is validated by an accredited testing laboratory.

OPERATIONS AND ALGORITHMS¶

The OpenSSL FIPS provider supports these operations and algorithms:

SELF TESTING¶

One of the requirements for the FIPS module is self testing. An optional callback mechanism is available to return information to the user using OSSL_SELF_TEST_set_callback(3).

The parameters passed to the callback are described in OSSL_SELF_TEST_new(3)

The OpenSSL FIPS module uses the following mechanism to provide information about the self tests as they run. This is useful for debugging if a self test is failing. The callback also allows forcing any self test to fail, in order to check that it operates correctly on failure. Note that all self tests run even if a self test failure occurs.

The FIPS module passes the following type(s) to OSSL_SELF_TEST_onbegin().

"Module_Integrity" (OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY)

Uses HMAC SHA256 on the module file to validate that the module has not been modified. The integrity value is compared to a value written to a configuration file during installation.

"Install_Integrity" (OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY)

Uses HMAC SHA256 on a fixed string to validate that the installation process has already been performed and the self test KATS have already been tested, The integrity value is compared to a value written to a configuration file after successfully running the self tests during installation.

"KAT_Cipher" (OSSL_SELF_TEST_TYPE_KAT_CIPHER)

Known answer test for a symmetric cipher.

"KAT_AsymmetricCipher" (OSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER)

Known answer test for a asymmetric cipher.

"KAT_Digest" (OSSL_SELF_TEST_TYPE_KAT_DIGEST)

Known answer test for a digest.

"KAT_Signature" (OSSL_SELF_TEST_TYPE_KAT_SIGNATURE)

Known answer test for a signature.

"PCT_Signature" (OSSL_SELF_TEST_TYPE_PCT_SIGNATURE)

Pairwise Consistency check for a signature.

"KAT_KDF" (OSSL_SELF_TEST_TYPE_KAT_KDF)

Known answer test for a key derivation function.

"KAT_KA" (OSSL_SELF_TEST_TYPE_KAT_KA)

Known answer test for key agreement.

"DRBG" (OSSL_SELF_TEST_TYPE_DRBG)

Known answer test for a Deterministic Random Bit Generator.

"Conditional_PCT" (OSSL_SELF_TEST_TYPE_PCT)

Conditional test that is run during the generation of key pairs.

"Continuous_RNG_Test" (OSSL_SELF_TEST_TYPE_CRNG)

Continuous random number generator test.

The "Module_Integrity" self test is always run at startup. The "Install_Integrity" self test is used to check if the self tests have already been run at installation time. If they have already run then the self tests are not run on subsequent startups. All other self test categories are run once at installation time, except for the "Pairwise_Consistency_Test".

There is only one instance of the "Module_Integrity" and "Install_Integrity" self tests. All other self tests may have multiple instances.

The FIPS module passes the following descriptions(s) to OSSL_SELF_TEST_onbegin().

"HMAC" (OSSL_SELF_TEST_DESC_INTEGRITY_HMAC)

"Module_Integrity" and "Install_Integrity" use this.

"RSA" (OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1)

"ECDSA" (OSSL_SELF_TEST_DESC_PCT_ECDSA)

"EDDSA" (OSSL_SELF_TEST_DESC_PCT_EDDSA)

"DSA" (OSSL_SELF_TEST_DESC_PCT_DSA)

Key generation tests used with the "Pairwise_Consistency_Test" type.

"RSA_Encrypt" (OSSL_SELF_TEST_DESC_ASYM_RSA_ENC)

"RSA_Decrypt" (OSSL_SELF_TEST_DESC_ASYM_RSA_DEC)

"KAT_AsymmetricCipher" uses this to indicate an encrypt or decrypt KAT.

"AES_GCM" (OSSL_SELF_TEST_DESC_CIPHER_AES_GCM)

"AES_ECB_Decrypt" (OSSL_SELF_TEST_DESC_CIPHER_AES_ECB)

"TDES" (OSSL_SELF_TEST_DESC_CIPHER_TDES)

Symmetric cipher tests used with the "KAT_Cipher" type.

"SHA1" (OSSL_SELF_TEST_DESC_MD_SHA1)

"SHA2" (OSSL_SELF_TEST_DESC_MD_SHA2)

"SHA3" (OSSL_SELF_TEST_DESC_MD_SHA3)

Digest tests used with the "KAT_Digest" type.

"DSA" (OSSL_SELF_TEST_DESC_SIGN_DSA)

"RSA" (OSSL_SELF_TEST_DESC_SIGN_RSA)

"ECDSA" (OSSL_SELF_TEST_DESC_SIGN_ECDSA)

Signature tests used with the "KAT_Signature" type.

"ECDH" (OSSL_SELF_TEST_DESC_KA_ECDH)

"DH" (OSSL_SELF_TEST_DESC_KA_DH)

Key agreement tests used with the "KAT_KA" type.

"HKDF" (OSSL_SELF_TEST_DESC_KDF_HKDF)

"TLS13_KDF_EXTRACT" (OSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT)

"TLS13_KDF_EXPAND" (OSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND)

"SSKDF" (OSSL_SELF_TEST_DESC_KDF_SSKDF)

"X963KDF" (OSSL_SELF_TEST_DESC_KDF_X963KDF)

"X942KDF" (OSSL_SELF_TEST_DESC_KDF_X942KDF)

"PBKDF2" (OSSL_SELF_TEST_DESC_KDF_PBKDF2)

"SSHKDF" (OSSL_SELF_TEST_DESC_KDF_SSHKDF)

"TLS12_PRF" (OSSL_SELF_TEST_DESC_KDF_TLS12_PRF)

"KBKDF" (OSSL_SELF_TEST_DESC_KDF_KBKDF)

Key Derivation Function tests used with the "KAT_KDF" type.

"CTR" (OSSL_SELF_TEST_DESC_DRBG_CTR)

"HASH" (OSSL_SELF_TEST_DESC_DRBG_HASH)

"HMAC" (OSSL_SELF_TEST_DESC_DRBG_HMAC)

DRBG tests used with the "DRBG" type.

"RNG" (OSSL_SELF_TEST_DESC_RNG)

"Continuous_RNG_Test" uses this.

EXAMPLES¶

A simple self test callback is shown below for illustrative purposes.

  #include <openssl/self_test.h>
  static OSSL_CALLBACK self_test_cb;
  static int self_test_cb(const OSSL_PARAM params[], void *arg)
  {
    int ret = 0;
    const OSSL_PARAM *p = NULL;
    const char *phase = NULL, *type = NULL, *desc = NULL;
    p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
    if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
        goto err;
    phase = (const char *)p->data;
    p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
    if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
        goto err;
    desc = (const char *)p->data;
    p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
    if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
        goto err;
    type = (const char *)p->data;
    /* Do some logging */
    if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
        BIO_printf(bio_out, "%s : (%s) : ", desc, type);
    if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0
            || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0)
        BIO_printf(bio_out, "%s\n", phase);
    /* Corrupt the SHA1 self test during the 'corrupt' phase by returning 0 */
    if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
            && strcmp(desc, OSSL_SELF_TEST_DESC_MD_SHA1) == 0) {
        BIO_printf(bio_out, "%s %s", phase, desc);
        return 0;
    }
    ret = 1;
  err:
    return ret;
  }

NOTES¶

Some released versions of OpenSSL do not include a validated FIPS provider. To determine which versions have undergone the validation process, please refer to the OpenSSL Downloads page <https://www.openssl.org/source/>. If you require FIPS-approved functionality, it is essential to build your FIPS provider using one of the validated versions listed there. Normally, it is possible to utilize a FIPS provider constructed from one of the validated versions alongside libcrypto and libssl compiled from any release within the same major release series. This flexibility enables you to address bug fixes and CVEs that fall outside the FIPS boundary.

The FIPS provider in OpenSSL 3.1 includes some non-FIPS validated algorithms, consequently the property query "fips=yes" is mandatory for applications that want to operate in a FIPS approved manner. The algorithms are:

Triple DES ECB

Triple DES CBC

EdDSA

SEE ALSO¶

openssl-fipsinstall(1), fips_config(5), OSSL_SELF_TEST_set_callback(3), OSSL_SELF_TEST_new(3), OSSL_PARAM(3), openssl-core.h(7), openssl-core_dispatch.h(7), provider(7), <https://www.openssl.org/source/>

HISTORY¶

This functionality was added in OpenSSL 3.0.

COPYRIGHT¶

Copyright 2019-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.