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-2. 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=default"
  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 "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 =item DES-EDE3 (TrippleDES), see L<EVP_CIPHER-DES(7)>
  66
  67 =back
  68
  69 =head2 Message Authentication Code (MAC)
  70
  71 =over 4
  72
  73 =item CMAC, see L<EVP_MAC-CMAC(7)>
  74
  75 =item GMAC, see L<EVP_MAC-GMAC(7)>
  76
  77 =item HMAC, see L<EVP_MAC-HMAC(7)>
  78
  79 =item KMAC, see L<EVP_MAC-KMAC(7)>
  80
  81 =back
  82
  83 =head2 Key Derivation Function (KDF)
  84
  85 =over 4
  86
  87 =item HKDF, see L<EVP_KDF-HKDF(7)>
  88
  89 =item SSKDF, see L<EVP_KDF-SSKDF(7)>
  90
  91 =item PBKDF2, see L<EVP_KDF-PBKDF2(7)>
  92
  93 =item TLS1-PRF, see L<EVP_KDF-TLS1-PRF(7)>
  94
  95 =item KBKDF, see L<EVP_KDF-KBKDF(7)>
  96
  97 =back
  98
  99 =head2 Key Exchange
 100
 101 =over 4
 102
 103 =item DH, see L<EVP_KEYEXCH-DH(7)>
 104
 105 =item ECDH, see L<EVP_KEYEXCH-ECDH(7)>
 106
 107 =item X25519, see L<EVP_KEYEXCH-X25519(7)>
 108
 109 This has the property "provider=fips,fips=no"
 110
 111 =item X448, see L<EVP_KEYEXCH-X448(7)>
 112
 113 This has the property "provider=fips,fips=no"
 114
 115 =back
 116
 117 =head2 Asymmetric Signature
 118
 119 =over 4
 120
 121 =item DSA, see L<EVP_KEYEXCH-DSA(7)>
 122
 123 =item RSA, see L<EVP_SIGNATURE-RSA(7)>
 124
 125 =item HMAC, see L<EVP_SIGNATURE-HMAC(7)>
 126
 127 =item CMAC, see L<EVP_SIGNATURE-CMAC(7)>
 128
 129 =back
 130
 131 =head2 Asymmetric Cipher
 132
 133 =over 4
 134
 135 =item RSA, see L<EVP_KEYEXCH-RSA(7)>
 136
 137 =back
 138
 139 =head2 Asymmetric Key Encapsulation
 140
 141 =over 4
 142
 143 =item RSA, see L<EVP_KEM-RSA(7)>
 144
 145 =back
 146
 147 =head2 Asymmetric Key Management
 148
 149 =over 4
 150
 151 =item DH, see L<EVP_KEYMGMT-DH(7)>
 152
 153 =item DSA, see L<EVP_KEYMGMT-DSA(7)>
 154
 155 =item RSA, see L<EVP_KEYMGMT-RSA(7)>
 156
 157 =back
 158
 159 =head1 SELF TESTING
 160
 161 One of the requirements for the FIPS module is self testing. An optional callback
 162 mechanism is available to return information to the user using
 163 L<OSSL_SELF_TEST_set_callback(3)>.
 164
 165 The parameters passed to the callback are described in L<OSSL_SELF_TEST_new(3)>
 166
 167 The OpenSSL FIPS module uses the following mechanism to provide information
 168 about the self tests as they run.
 169 This is useful for debugging if a self test is failing.
 170 The callback also allows forcing any self test to fail, in order to check that
 171 it operates correctly on failure.
 172 Note that all self tests run even if a self test failure occurs.
 173
 174 The FIPS module passes the following type(s) to OSSL_SELF_TEST_onbegin().
 175
 176 =over 4
 177
 178 =item "Module_Integrity" (B<OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY>)
 179
 180 Uses HMAC SHA256 on the module file to validate that the module has not been
 181 modified. The integrity value is compared to a value written to a configuration
 182 file during installation.
 183
 184 =item "Install_Integrity" (B<OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY>)
 185
 186 Uses HMAC SHA256 on a fixed string to validate that the installation process
 187 has already been performed and the self test KATS have already been tested,
 188 The integrity value is compared to a value written to a configuration
 189 file after successfully running the self tests during installation.
 190
 191 =item "KAT_Cipher" (B<OSSL_SELF_TEST_TYPE_KAT_CIPHER>)
 192
 193 Known answer test for a symmetric cipher.
 194
 195 =item "KAT_AsymmetricCipher" (B<OSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER>)
 196
 197 Known answer test for a asymmetric cipher.
 198
 199 =item "KAT_Digest" (B<OSSL_SELF_TEST_TYPE_KAT_DIGEST>)
 200
 201 Known answer test for a digest.
 202
 203 =item "KAT_Signature" (B<OSSL_SELF_TEST_TYPE_KAT_SIGNATURE>)
 204
 205 Known answer test for a signature.
 206
 207 =item "KAT_KDF" (B<OSSL_SELF_TEST_TYPE_KAT_KDF>)
 208
 209 Known answer test for a key derivation function.
 210
 211 =item "KAT_KA" (B<OSSL_SELF_TEST_TYPE_KAT_KA>)
 212
 213 Known answer test for key agreement.
 214
 215 =item "DRBG" (B<OSSL_SELF_TEST_TYPE_DRBG>)
 216
 217 Known answer test for a Deterministic Random Bit Generator.
 218
 219 =item "Pairwise_Consistency_Test" (B<OSSL_SELF_TEST_TYPE_PCT>)
 220
 221 Conditional test that is run during the generation of key pairs.
 222
 223 =item "Continuous_RNG_Test" (B<OSSL_SELF_TEST_TYPE_CRNG>)
 224
 225 Continuous random number generator test.
 226
 227 =back
 228
 229 The "Module_Integrity" self test is always run at startup.
 230 The "Install_Integrity" self test is used to check if the self tests have
 231 already been run at installation time. If they have already run then the
 232 self tests are not run on subsequent startups.
 233 All other self test categories are run once at installation time, except for the
 234 "Pairwise_Consistency_Test".
 235
 236 There is only one instance of the "Module_Integrity" and "Install_Integrity"
 237 self tests. All other self tests may have multiple instances.
 238
 239
 240 The FIPS module passes the following descriptions(s) to OSSL_SELF_TEST_onbegin().
 241
 242 =over 4
 243
 244 =item "HMAC" (B<OSSL_SELF_TEST_DESC_INTEGRITY_HMAC>)
 245
 246 "Module_Integrity" and "Install_Integrity" use this.
 247
 248 =item "RSA" (B<OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1>)
 249
 250 =item "ECDSA" (B<OSSL_SELF_TEST_DESC_PCT_ECDSA>)
 251
 252 =item "DSA" (B<OSSL_SELF_TEST_DESC_PCT_DSA>)
 253
 254 Key generation tests used with the "Pairwise_Consistency_Test" type.
 255
 256 =item "RSA_Encrypt" (B<OSSL_SELF_TEST_DESC_ASYM_RSA_ENC>)
 257
 258 =item "RSA_Decrypt" (B<OSSL_SELF_TEST_DESC_ASYM_RSA_DEC>)
 259
 260 "KAT_AsymmetricCipher" uses this to indicate an encrypt or decrypt KAT.
 261
 262 =item "AES_GCM" (B<OSSL_SELF_TEST_DESC_CIPHER_AES_GCM>)
 263
 264 =item "TDES" (B<OSSL_SELF_TEST_DESC_CIPHER_TDES>)
 265
 266 Symmetric cipher tests used with the "KAT_Cipher" type.
 267
 268 =item "SHA1" (B<OSSL_SELF_TEST_DESC_MD_SHA1>)
 269
 270 =item "SHA2" (B<OSSL_SELF_TEST_DESC_MD_SHA2>)
 271
 272 =item "SHA3" (B<OSSL_SELF_TEST_DESC_MD_SHA3>)
 273
 274 Digest tests used with the "KAT_Digest" type.
 275
 276 =item "DSA" (B<OSSL_SELF_TEST_DESC_SIGN_DSA>)
 277
 278 =item "RSA" (B<OSSL_SELF_TEST_DESC_SIGN_RSA>)
 279
 280 =item "ECDSA" (B<OSSL_SELF_TEST_DESC_SIGN_ECDSA>)
 281
 282 Signature tests used with the "KAT_Signature" type.
 283
 284 =item "ECDH" (B<OSSL_SELF_TEST_DESC_KA_ECDH>)
 285
 286 =item "DH" (B<OSSL_SELF_TEST_DESC_KA_DH>)
 287
 288 Key agreement tests used with the "KAT_KA" type.
 289
 290 =item "HKDF" (B<OSSL_SELF_TEST_DESC_KDF_HKDF>)
 291
 292 =item "SSKDF" (B<OSSL_SELF_TEST_DESC_KDF_SSKDF>)
 293
 294 Key Derivation Function tests used with the "KAT_KDF" type.
 295
 296 =item "CTR" (B<OSSL_SELF_TEST_DESC_DRBG_CTR>)
 297
 298 =item "HASH" (B<OSSL_SELF_TEST_DESC_DRBG_HASH>)
 299
 300 =item "HMAC" (B<OSSL_SELF_TEST_DESC_DRBG_HMAC>)
 301
 302 DRBG tests used with the "DRBG" type.
 303
 304 = item "RNG" (B<OSSL_SELF_TEST_DESC_RNG>)
 305
 306 "Continuous_RNG_Test" uses this.
 307
 308 =back
 309
 310 =head1 EXAMPLES
 311
 312 A simple self test callback is shown below for illustrative purposes.
 313
 314   #include <openssl/self_test.h>
 315
 316   static OSSL_CALLBACK self_test_cb;
 317
 318   static int self_test_cb(const OSSL_PARAM params[], void *arg)
 319   {
 320     int ret = 0;
 321     const OSSL_PARAM *p = NULL;
 322     const char *phase = NULL, *type = NULL, *desc = NULL;
 323
 324     p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
 325     if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
 326         goto err;
 327     phase = (const char *)p->data;
 328
 329     p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
 330     if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
 331         goto err;
 332     desc = (const char *)p->data;
 333
 334     p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
 335     if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
 336         goto err;
 337     type = (const char *)p->data;
 338
 339     /* Do some logging */
 340     if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
 341         BIO_printf(bio_out, "%s : (%s) : ", desc, type);
 342     if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0
 343             || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0)
 344         BIO_printf(bio_out, "%s\n", phase);
 345
 346     /* Corrupt the SHA1 self test during the 'corrupt' phase by returning 0 */
 347     if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
 348             && strcmp(desc, OSSL_SELF_TEST_DESC_MD_SHA1) == 0) {
 349         BIO_printf(bio_out, "%s %s", phase, desc);
 350         return 0;
 351     }
 352     ret = 1;
 353   err:
 354     return ret;
 355   }
 356
 357 =head1 SEE ALSO
 358
 359 L<openssl-fipsinstall(1)>,
 360 L<fips_config(5)>,
 361 L<OSSL_SELF_TEST_set_callback(3)>,
 362 L<OSSL_SELF_TEST_new(3)>,
 363 L<OSSL_PARAM(3)>,
 364 L<openssl-core.h(7)>,
 365 L<openssl-core_dispatch.h(7)>,
 366 L<provider(7)>
 367
 368 =head1 HISTORY
 369
 370 The type and functions described here were added in OpenSSL 3.0.
 371
 372 =head1 COPYRIGHT
 373
 374 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
 375
 376 Licensed under the Apache License 2.0 (the "License").  You may not use
 377 this file except in compliance with the License.  You can obtain a copy
 378 in the file LICENSE in the source distribution or at
 379 L<https://www.openssl.org/source/license.html>.
 380
 381 =cut