doc/man7/OSSL_PROVIDER-FIPS.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_PROVIDER-FIPS - OpenSSL FIPS provider
   6
   7 =head1 DESCRIPTION
   8
   9 The OpenSSL FIPS provider is a special provider that conforms to the Federal
  10 Information Processing Standards (FIPS) specified in FIPS 140-3. This 'module'
  11 contains an approved set of cryptographic algorithms that is validated by an
  12 accredited testing laboratory.
  13
  14 =head2 Properties
  15
  16 The implementations in this provider specifically have these properties
  17 defined:
  18
  19 =over 4
  20
  21 =item "provider=fips"
  22
  23 =item "fips=yes"
  24
  25 =back
  26
  27 It may be used in a property query string with fetching functions such as
  28 L<EVP_MD_fetch(3)> or L<EVP_CIPHER_fetch(3)>, as well as with other
  29 functions that take a property query string, such as
  30 L<EVP_PKEY_CTX_new_from_name(3)>.
  31
  32 It isn't mandatory to query for any of these properties, except to
  33 make sure to get implementations of this provider and none other.
  34
  35 The C<fips=yes> property can be use to make sure only FIPS approved
  36 implementations are used for crypto operations.  This may also include
  37 other non-crypto support operations that are not in the FIPS provider,
  38 such as asymmetric key encoders,
  39 see L<OSSL_PROVIDER-default(7)/Asymmetric Key Management>.
  40
  41 =head1 OPERATIONS AND ALGORITHMS
  42
  43 The OpenSSL FIPS provider supports these operations and algorithms:
  44
  45 =head2 Hashing Algorithms / Message Digests
  46
  47 =over 4
  48
  49 =item SHA1, see L<EVP_MD-SHA1(7)>
  50
  51 =item SHA2, see L<EVP_MD-SHA2(7)>
  52
  53 =item SHA3, see L<EVP_MD-SHA3(7)>
  54
  55 =item KECCAK-KMAC, see L<EVP_MD-KECCAK-KMAC(7)>
  56
  57 =back
  58
  59 =head2 Symmetric Ciphers
  60
  61 =over 4
  62
  63 =item AES, see L<EVP_CIPHER-AES(7)>
  64
  65 =back
  66
  67 =head2 Message Authentication Code (MAC)
  68
  69 =over 4
  70
  71 =item CMAC, see L<EVP_MAC-CMAC(7)>
  72
  73 =item GMAC, see L<EVP_MAC-GMAC(7)>
  74
  75 =item HMAC, see L<EVP_MAC-HMAC(7)>
  76
  77 =item KMAC, see L<EVP_MAC-KMAC(7)>
  78
  79 =back
  80
  81 =head2 Key Derivation Function (KDF)
  82
  83 =over 4
  84
  85 =item HKDF, see L<EVP_KDF-HKDF(7)>
  86
  87 =item TLS13-KDF, see L<EVP_KDF-TLS13_KDF(7)>
  88
  89 =item SSKDF, see L<EVP_KDF-SS(7)>
  90
  91 =item PBKDF2, see L<EVP_KDF-PBKDF2(7)>
  92
  93 =item SSHKDF, see L<EVP_KDF-SSHKDF(7)>
  94
  95 =item TLS1-PRF, see L<EVP_KDF-TLS1_PRF(7)>
  96
  97 =item KBKDF, see L<EVP_KDF-KB(7)>
  98
  99 =item X942KDF-ASN1, see L<EVP_KDF-X942-ASN1(7)>
 100
 101 =item X942KDF-CONCAT, see L<EVP_KDF-X942-CONCAT(7)>
 102
 103 =item X963KDF, see L<EVP_KDF-X963(7)>
 104
 105 =back
 106
 107 =head2 Key Exchange
 108
 109 =over 4
 110
 111 =item DH, see L<EVP_KEYEXCH-DH(7)>
 112
 113 =item ECDH, see L<EVP_KEYEXCH-ECDH(7)>
 114
 115 =item X25519, see L<EVP_KEYEXCH-X25519(7)>
 116
 117 =item X448, see L<EVP_KEYEXCH-X448(7)>
 118
 119 =back
 120
 121 =head2 Asymmetric Signature
 122
 123 =over 4
 124
 125 =item RSA, see L<EVP_SIGNATURE-RSA(7)>
 126
 127 =item X25519, see L<EVP_SIGNATURE-ED25519(7)>
 128
 129 =item X448, see L<EVP_SIGNATURE-ED448(7)>
 130
 131 =item HMAC, see L<EVP_SIGNATURE-HMAC(7)>
 132
 133 =item CMAC, see L<EVP_SIGNATURE-CMAC(7)>
 134
 135 =back
 136
 137 =head2 Asymmetric Cipher
 138
 139 =over 4
 140
 141 =item RSA, see L<EVP_ASYM_CIPHER-RSA(7)>
 142
 143 =back
 144
 145 =head2 Asymmetric Key Encapsulation
 146
 147 =over 4
 148
 149 =item RSA, see L<EVP_KEM-RSA(7)>
 150
 151 =back
 152
 153 =head2 Asymmetric Key Management
 154
 155 =over 4
 156
 157 =item DH, see L<EVP_KEYMGMT-DH(7)>
 158
 159 =item DHX, see L<EVP_KEYMGMT-DHX(7)>
 160
 161 =item DSA, see L<EVP_KEYMGMT-DSA(7)>
 162
 163 =item RSA, see L<EVP_KEYMGMT-RSA(7)>
 164
 165 =item EC, see L<EVP_KEYMGMT-EC(7)>
 166
 167 =item X25519, see L<EVP_KEYMGMT-X25519(7)>
 168
 169 =item X448, see L<EVP_KEYMGMT-X448(7)>
 170
 171 =back
 172
 173 =head1 SELF TESTING
 174
 175 One of the requirements for the FIPS module is self testing. An optional callback
 176 mechanism is available to return information to the user using
 177 L<OSSL_SELF_TEST_set_callback(3)>.
 178
 179 The parameters passed to the callback are described in L<OSSL_SELF_TEST_new(3)>
 180
 181 The OpenSSL FIPS module uses the following mechanism to provide information
 182 about the self tests as they run.
 183 This is useful for debugging if a self test is failing.
 184 The callback also allows forcing any self test to fail, in order to check that
 185 it operates correctly on failure.
 186 Note that all self tests run even if a self test failure occurs.
 187
 188 The FIPS module passes the following type(s) to OSSL_SELF_TEST_onbegin().
 189
 190 =over 4
 191
 192 =item "Module_Integrity" (B<OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY>)
 193
 194 Uses HMAC SHA256 on the module file to validate that the module has not been
 195 modified. The integrity value is compared to a value written to a configuration
 196 file during installation.
 197
 198 =item "Install_Integrity" (B<OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY>)
 199
 200 Uses HMAC SHA256 on a fixed string to validate that the installation process
 201 has already been performed and the self test KATS have already been tested,
 202 The integrity value is compared to a value written to a configuration
 203 file after successfully running the self tests during installation.
 204
 205 =item "KAT_Cipher" (B<OSSL_SELF_TEST_TYPE_KAT_CIPHER>)
 206
 207 Known answer test for a symmetric cipher.
 208
 209 =item "KAT_AsymmetricCipher" (B<OSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER>)
 210
 211 Known answer test for a asymmetric cipher.
 212
 213 =item "KAT_Digest" (B<OSSL_SELF_TEST_TYPE_KAT_DIGEST>)
 214
 215 Known answer test for a digest.
 216
 217 =item "KAT_Signature" (B<OSSL_SELF_TEST_TYPE_KAT_SIGNATURE>)
 218
 219 Known answer test for a signature.
 220
 221 =item "PCT_Signature" (B<OSSL_SELF_TEST_TYPE_PCT_SIGNATURE>)
 222
 223 Pairwise Consistency check for a signature.
 224
 225 =item "KAT_KDF" (B<OSSL_SELF_TEST_TYPE_KAT_KDF>)
 226
 227 Known answer test for a key derivation function.
 228
 229 =item "KAT_KA" (B<OSSL_SELF_TEST_TYPE_KAT_KA>)
 230
 231 Known answer test for key agreement.
 232
 233 =item "DRBG" (B<OSSL_SELF_TEST_TYPE_DRBG>)
 234
 235 Known answer test for a Deterministic Random Bit Generator.
 236
 237 =item "Conditional_PCT" (B<OSSL_SELF_TEST_TYPE_PCT>)
 238
 239 Conditional test that is run during the generation of key pairs.
 240
 241 =item "Continuous_RNG_Test" (B<OSSL_SELF_TEST_TYPE_CRNG>)
 242
 243 Continuous random number generator test.
 244
 245 =back
 246
 247 The "Module_Integrity" self test is always run at startup.
 248 The "Install_Integrity" self test is used to check if the self tests have
 249 already been run at installation time. If they have already run then the
 250 self tests are not run on subsequent startups.
 251 All other self test categories are run once at installation time, except for the
 252 "Pairwise_Consistency_Test".
 253
 254 There is only one instance of the "Module_Integrity" and "Install_Integrity"
 255 self tests. All other self tests may have multiple instances.
 256
 257
 258 The FIPS module passes the following descriptions(s) to OSSL_SELF_TEST_onbegin().
 259
 260 =over 4
 261
 262 =item "HMAC" (B<OSSL_SELF_TEST_DESC_INTEGRITY_HMAC>)
 263
 264 "Module_Integrity" and "Install_Integrity" use this.
 265
 266 =item "RSA" (B<OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1>)
 267
 268 =item "ECDSA" (B<OSSL_SELF_TEST_DESC_PCT_ECDSA>)
 269
 270 =item "DSA" (B<OSSL_SELF_TEST_DESC_PCT_DSA>)
 271
 272 Key generation tests used with the "Pairwise_Consistency_Test" type.
 273
 274 =item "RSA_Encrypt" (B<OSSL_SELF_TEST_DESC_ASYM_RSA_ENC>)
 275
 276 =item "RSA_Decrypt" (B<OSSL_SELF_TEST_DESC_ASYM_RSA_DEC>)
 277
 278 "KAT_AsymmetricCipher" uses this to indicate an encrypt or decrypt KAT.
 279
 280 =item "AES_GCM" (B<OSSL_SELF_TEST_DESC_CIPHER_AES_GCM>)
 281
 282 =item "AES_ECB_Decrypt" (B<OSSL_SELF_TEST_DESC_CIPHER_AES_ECB>)
 283
 284 =item "TDES" (B<OSSL_SELF_TEST_DESC_CIPHER_TDES>)
 285
 286 Symmetric cipher tests used with the "KAT_Cipher" type.
 287
 288 =item "SHA1" (B<OSSL_SELF_TEST_DESC_MD_SHA1>)
 289
 290 =item "SHA2" (B<OSSL_SELF_TEST_DESC_MD_SHA2>)
 291
 292 =item "SHA3" (B<OSSL_SELF_TEST_DESC_MD_SHA3>)
 293
 294 Digest tests used with the "KAT_Digest" type.
 295
 296 =item "DSA" (B<OSSL_SELF_TEST_DESC_SIGN_DSA>)
 297
 298 =item "RSA" (B<OSSL_SELF_TEST_DESC_SIGN_RSA>)
 299
 300 =item "ECDSA" (B<OSSL_SELF_TEST_DESC_SIGN_ECDSA>)
 301
 302 Signature tests used with the "KAT_Signature" type.
 303
 304 =item "ECDH" (B<OSSL_SELF_TEST_DESC_KA_ECDH>)
 305
 306 =item "DH" (B<OSSL_SELF_TEST_DESC_KA_DH>)
 307
 308 Key agreement tests used with the "KAT_KA" type.
 309
 310 =item "HKDF" (B<OSSL_SELF_TEST_DESC_KDF_HKDF>)
 311
 312 =item "TLS13_KDF_EXTRACT" (B<OSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT>)
 313
 314 =item "TLS13_KDF_EXPAND" (B<OSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND>)
 315
 316 =item "SSKDF" (B<OSSL_SELF_TEST_DESC_KDF_SSKDF>)
 317
 318 =item "X963KDF" (B<OSSL_SELF_TEST_DESC_KDF_X963KDF>)
 319
 320 =item "X942KDF" (B<OSSL_SELF_TEST_DESC_KDF_X942KDF>)
 321
 322 =item "PBKDF2" (B<OSSL_SELF_TEST_DESC_KDF_PBKDF2>)
 323
 324 =item "SSHKDF" (B<OSSL_SELF_TEST_DESC_KDF_SSHKDF>)
 325
 326 =item "TLS12_PRF" (B<OSSL_SELF_TEST_DESC_KDF_TLS12_PRF>)
 327
 328 =item "KBKDF" (B<OSSL_SELF_TEST_DESC_KDF_KBKDF>)
 329
 330 Key Derivation Function tests used with the "KAT_KDF" type.
 331
 332 =item "CTR" (B<OSSL_SELF_TEST_DESC_DRBG_CTR>)
 333
 334 =item "HASH" (B<OSSL_SELF_TEST_DESC_DRBG_HASH>)
 335
 336 =item "HMAC" (B<OSSL_SELF_TEST_DESC_DRBG_HMAC>)
 337
 338 DRBG tests used with the "DRBG" type.
 339
 340 = item "RNG" (B<OSSL_SELF_TEST_DESC_RNG>)
 341
 342 "Continuous_RNG_Test" uses this.
 343
 344 =back
 345
 346 =head1 EXAMPLES
 347
 348 A simple self test callback is shown below for illustrative purposes.
 349
 350   #include <openssl/self_test.h>
 351
 352   static OSSL_CALLBACK self_test_cb;
 353
 354   static int self_test_cb(const OSSL_PARAM params[], void *arg)
 355   {
 356     int ret = 0;
 357     const OSSL_PARAM *p = NULL;
 358     const char *phase = NULL, *type = NULL, *desc = NULL;
 359
 360     p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
 361     if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
 362         goto err;
 363     phase = (const char *)p->data;
 364
 365     p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
 366     if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
 367         goto err;
 368     desc = (const char *)p->data;
 369
 370     p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
 371     if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
 372         goto err;
 373     type = (const char *)p->data;
 374
 375     /* Do some logging */
 376     if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
 377         BIO_printf(bio_out, "%s : (%s) : ", desc, type);
 378     if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0
 379             || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0)
 380         BIO_printf(bio_out, "%s\n", phase);
 381
 382     /* Corrupt the SHA1 self test during the 'corrupt' phase by returning 0 */
 383     if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
 384             && strcmp(desc, OSSL_SELF_TEST_DESC_MD_SHA1) == 0) {
 385         BIO_printf(bio_out, "%s %s", phase, desc);
 386         return 0;
 387     }
 388     ret = 1;
 389   err:
 390     return ret;
 391   }
 392
 393 =head1 NOTES
 394
 395 The FIPS provider in OpenSSL 3.1 includes some non-FIPS validated algorithms,
 396 consequently the property query C<fips=yes> is mandatory for applications that
 397 want to operate in a FIPS approved manner.  The algorithms are:
 398
 399 =over 4
 400
 401 =item Triple DES
 402
 403 =item EdDSA
 404
 405 =back
 406
 407 =head1 SEE ALSO
 408
 409 L<openssl-fipsinstall(1)>,
 410 L<fips_config(5)>,
 411 L<OSSL_SELF_TEST_set_callback(3)>,
 412 L<OSSL_SELF_TEST_new(3)>,
 413 L<OSSL_PARAM(3)>,
 414 L<openssl-core.h(7)>,
 415 L<openssl-core_dispatch.h(7)>,
 416 L<provider(7)>
 417
 418 =head1 HISTORY
 419
 420 This functionality was added in OpenSSL 3.0.
 421
 422 OpenSSL 3.0 includes a FIPS 140-2 approved FIPS provider.
 423
 424 OpenSSL 3.1 includes a FIPS 140-3 approved FIPS provider.
 425
 426 =head1 COPYRIGHT
 427
 428 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 429
 430 Licensed under the Apache License 2.0 (the "License").  You may not use
 431 this file except in compliance with the License.  You can obtain a copy
 432 in the file LICENSE in the source distribution or at
 433 L<https://www.openssl.org/source/license.html>.
 434
 435 =cut