providers/fips/fipsprov.c

   1 /*
   2  * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <string.h>
  11 #include <stdio.h>
  12 #include <openssl/core.h>
  13 #include <openssl/core_numbers.h>
  14 #include <openssl/core_names.h>
  15 #include <openssl/params.h>
  16 #include <openssl/err.h>
  17 #include <openssl/evp.h>
  18
  19 /* TODO(3.0): Needed for dummy_evp_call(). To be removed */
  20 #include <openssl/sha.h>
  21 #include <openssl/rand_drbg.h>
  22
  23 #include "internal/cryptlib.h"
  24 #include "internal/property.h"
  25 #include "internal/evp_int.h"
  26 #include "internal/provider_algs.h"
  27 #include "internal/provider_ctx.h"
  28 #include "internal/providercommon.h"
  29
  30 /*
  31  * TODO(3.0): Should these be stored in the provider side provctx? Could they
  32  * ever be different from one init to the next? Unfortunately we can't do this
  33  * at the moment because c_put_error/c_add_error_vdata do not provide us with
  34  * the OPENSSL_CTX as a parameter.
  35  */
  36 /* Functions provided by the core */
  37 static OSSL_core_get_param_types_fn *c_get_param_types = NULL;
  38 static OSSL_core_get_params_fn *c_get_params = NULL;
  39 extern OSSL_core_thread_start_fn *c_thread_start;
  40 OSSL_core_thread_start_fn *c_thread_start = NULL;
  41 static OSSL_core_put_error_fn *c_put_error = NULL;
  42 static OSSL_core_add_error_vdata_fn *c_add_error_vdata = NULL;
  43
  44 typedef struct fips_global_st {
  45     const OSSL_PROVIDER *prov;
  46 } FIPS_GLOBAL;
  47
  48 static void *fips_prov_ossl_ctx_new(OPENSSL_CTX *libctx)
  49 {
  50     FIPS_GLOBAL *fgbl = OPENSSL_zalloc(sizeof(*fgbl));
  51
  52     return fgbl;
  53 }
  54
  55 static void fips_prov_ossl_ctx_free(void *fgbl)
  56 {
  57     OPENSSL_free(fgbl);
  58 }
  59
  60 static const OPENSSL_CTX_METHOD fips_prov_ossl_ctx_method = {
  61     fips_prov_ossl_ctx_new,
  62     fips_prov_ossl_ctx_free,
  63 };
  64
  65
  66 /* Parameters we provide to the core */
  67 static const OSSL_ITEM fips_param_types[] = {
  68     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_NAME },
  69     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_VERSION },
  70     { OSSL_PARAM_UTF8_PTR, OSSL_PROV_PARAM_BUILDINFO },
  71     { 0, NULL }
  72 };
  73
  74 /* TODO(3.0): To be removed */
  75 static int dummy_evp_call(void *provctx)
  76 {
  77     OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
  78     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
  79     EVP_MD *sha256 = EVP_MD_fetch(libctx, "SHA256", NULL);
  80     char msg[] = "Hello World!";
  81     const unsigned char exptd[] = {
  82         0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
  83         0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
  84         0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
  85     };
  86     unsigned int dgstlen = 0;
  87     unsigned char dgst[SHA256_DIGEST_LENGTH];
  88     int ret = 0;
  89     BN_CTX *bnctx = NULL;
  90     BIGNUM *a = NULL, *b = NULL;
  91     unsigned char randbuf[128];
  92     RAND_DRBG *drbg = OPENSSL_CTX_get0_public_drbg(libctx);
  93
  94     if (ctx == NULL || sha256 == NULL || drbg == NULL)
  95         goto err;
  96
  97     if (!EVP_DigestInit_ex(ctx, sha256, NULL))
  98         goto err;
  99     if (!EVP_DigestUpdate(ctx, msg, sizeof(msg) - 1))
 100         goto err;
 101     if (!EVP_DigestFinal(ctx, dgst, &dgstlen))
 102         goto err;
 103     if (dgstlen != sizeof(exptd) || memcmp(dgst, exptd, sizeof(exptd)) != 0)
 104         goto err;
 105
 106     bnctx = BN_CTX_new_ex(libctx);
 107     if (bnctx == NULL)
 108         goto err;
 109     BN_CTX_start(bnctx);
 110     a = BN_CTX_get(bnctx);
 111     b = BN_CTX_get(bnctx);
 112     if (b == NULL)
 113         goto err;
 114     BN_zero(a);
 115     if (!BN_one(b)
 116         || !BN_add(a, a, b)
 117         || BN_cmp(a, b) != 0)
 118         goto err;
 119
 120     if (RAND_DRBG_bytes(drbg, randbuf, sizeof(randbuf)) <= 0)
 121         goto err;
 122
 123     if (!BN_rand_ex(a, 256, BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY, bnctx))
 124         goto err;
 125
 126     ret = 1;
 127  err:
 128     BN_CTX_end(bnctx);
 129     BN_CTX_free(bnctx);
 130
 131     EVP_MD_CTX_free(ctx);
 132     EVP_MD_meth_free(sha256);
 133     return ret;
 134 }
 135
 136 static const OSSL_ITEM *fips_get_param_types(const OSSL_PROVIDER *prov)
 137 {
 138     return fips_param_types;
 139 }
 140
 141 static int fips_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
 142 {
 143     OSSL_PARAM *p;
 144
 145     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
 146     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL FIPS Provider"))
 147         return 0;
 148     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
 149     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
 150         return 0;
 151     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
 152     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
 153         return 0;
 154
 155     return 1;
 156 }
 157
 158 /* FIPS specific version of the function of the same name in provlib.c */
 159 const char *ossl_prov_util_nid_to_name(int nid)
 160 {
 161     /* We don't have OBJ_nid2n() in FIPS_MODE so we have an explicit list */
 162
 163     switch (nid) {
 164     /* Digests */
 165     case NID_sha1:
 166         return "SHA224";
 167     case NID_sha224:
 168         return "SHA224";
 169     case NID_sha256:
 170         return "SHA256";
 171     case NID_sha384:
 172         return "SHA384";
 173     case NID_sha512:
 174         return "SHA512";
 175     case NID_sha512_224:
 176         return "SHA512-224";
 177     case NID_sha512_256:
 178         return "SHA512-256";
 179     case NID_sha3_224:
 180         return "SHA3-224";
 181     case NID_sha3_256:
 182         return "SHA3-256";
 183     case NID_sha3_384:
 184         return "SHA3-384";
 185     case NID_sha3_512:
 186         return "SHA3-512";
 187
 188     /* Ciphers */
 189     case NID_aes_256_ecb:
 190         return "AES-256-ECB";
 191     case NID_aes_192_ecb:
 192         return "AES-192-ECB";
 193     case NID_aes_128_ecb:
 194         return "AES-128-ECB";
 195     case NID_aes_256_cbc:
 196         return "AES-256-CBC";
 197     case NID_aes_192_cbc:
 198         return "AES-192-CBC";
 199     case NID_aes_128_cbc:
 200         return "AES-128-CBC";
 201     case NID_aes_256_ctr:
 202         return "AES-256-CTR";
 203     case NID_aes_192_ctr:
 204         return "AES-192-CTR";
 205     case NID_aes_128_ctr:
 206         return "AES-128-CTR";
 207     }
 208
 209     return NULL;
 210 }
 211
 212 static const OSSL_ALGORITHM fips_digests[] = {
 213     { "SHA1", "fips=yes", sha1_functions },
 214     { "SHA224", "fips=yes", sha224_functions },
 215     { "SHA256", "fips=yes", sha256_functions },
 216     { "SHA384", "fips=yes", sha384_functions },
 217     { "SHA512", "fips=yes", sha512_functions },
 218     { "SHA512-224", "fips=yes", sha512_224_functions },
 219     { "SHA512-256", "fips=yes", sha512_256_functions },
 220     { "SHA3-224", "fips=yes", sha3_224_functions },
 221     { "SHA3-256", "fips=yes", sha3_256_functions },
 222     { "SHA3-384", "fips=yes", sha3_384_functions },
 223     { "SHA3-512", "fips=yes", sha3_512_functions },
 224     { "KMAC128", "fips=yes", keccak_kmac_128_functions },
 225     { "KMAC256", "fips=yes", keccak_kmac_256_functions },
 226
 227     { NULL, NULL, NULL }
 228 };
 229
 230 static const OSSL_ALGORITHM fips_ciphers[] = {
 231     { "AES-256-ECB", "fips=yes", aes256ecb_functions },
 232     { "AES-192-ECB", "fips=yes", aes192ecb_functions },
 233     { "AES-128-ECB", "fips=yes", aes128ecb_functions },
 234     { "AES-256-CBC", "fips=yes", aes256cbc_functions },
 235     { "AES-192-CBC", "fips=yes", aes192cbc_functions },
 236     { "AES-128-CBC", "fips=yes", aes128cbc_functions },
 237     { "AES-256-CTR", "fips=yes", aes256ctr_functions },
 238     { "AES-192-CTR", "fips=yes", aes192ctr_functions },
 239     { "AES-128-CTR", "fips=yes", aes128ctr_functions },
 240     { NULL, NULL, NULL }
 241 };
 242
 243 static const OSSL_ALGORITHM *fips_query(OSSL_PROVIDER *prov,
 244                                          int operation_id,
 245                                          int *no_cache)
 246 {
 247     *no_cache = 0;
 248     switch (operation_id) {
 249     case OSSL_OP_DIGEST:
 250         return fips_digests;
 251     case OSSL_OP_CIPHER:
 252         return fips_ciphers;
 253     }
 254     return NULL;
 255 }
 256
 257 /* Functions we provide to the core */
 258 static const OSSL_DISPATCH fips_dispatch_table[] = {
 259     /*
 260      * To release our resources we just need to free the OPENSSL_CTX so we just
 261      * use OPENSSL_CTX_free directly as our teardown function
 262      */
 263     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))OPENSSL_CTX_free },
 264     { OSSL_FUNC_PROVIDER_GET_PARAM_TYPES, (void (*)(void))fips_get_param_types },
 265     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
 266     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
 267     { 0, NULL }
 268 };
 269
 270 /* Functions we provide to ourself */
 271 static const OSSL_DISPATCH intern_dispatch_table[] = {
 272     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
 273     { 0, NULL }
 274 };
 275
 276
 277 int OSSL_provider_init(const OSSL_PROVIDER *provider,
 278                        const OSSL_DISPATCH *in,
 279                        const OSSL_DISPATCH **out,
 280                        void **provctx)
 281 {
 282     FIPS_GLOBAL *fgbl;
 283     OPENSSL_CTX *ctx;
 284
 285     for (; in->function_id != 0; in++) {
 286         switch (in->function_id) {
 287         case OSSL_FUNC_CORE_GET_PARAM_TYPES:
 288             c_get_param_types = OSSL_get_core_get_param_types(in);
 289             break;
 290         case OSSL_FUNC_CORE_GET_PARAMS:
 291             c_get_params = OSSL_get_core_get_params(in);
 292             break;
 293         case OSSL_FUNC_CORE_THREAD_START:
 294             c_thread_start = OSSL_get_core_thread_start(in);
 295             break;
 296         case OSSL_FUNC_CORE_PUT_ERROR:
 297             c_put_error = OSSL_get_core_put_error(in);
 298             break;
 299         case OSSL_FUNC_CORE_ADD_ERROR_VDATA:
 300             c_add_error_vdata = OSSL_get_core_add_error_vdata(in);
 301             break;
 302         /* Just ignore anything we don't understand */
 303         default:
 304             break;
 305         }
 306     }
 307
 308     ctx = OPENSSL_CTX_new();
 309     if (ctx == NULL)
 310         return 0;
 311
 312     fgbl = openssl_ctx_get_data(ctx, OPENSSL_CTX_FIPS_PROV_INDEX,
 313                                 &fips_prov_ossl_ctx_method);
 314
 315     if (fgbl == NULL)
 316         goto err;
 317
 318     fgbl->prov = provider;
 319
 320     *out = fips_dispatch_table;
 321     *provctx = ctx;
 322
 323     /*
 324      * TODO(3.0): Remove me. This is just a dummy call to demonstrate making
 325      * EVP calls from within the FIPS module.
 326      */
 327     if (!dummy_evp_call(*provctx)) {
 328         OPENSSL_CTX_free(*provctx);
 329         *provctx = NULL;
 330         return 0;
 331     }
 332
 333     return 1;
 334
 335  err:
 336     OPENSSL_CTX_free(ctx);
 337     return 0;
 338 }
 339
 340 /*
 341  * The internal init function used when the FIPS module uses EVP to call
 342  * another algorithm also in the FIPS module. This is a recursive call that has
 343  * been made from within the FIPS module itself. To make this work, we populate
 344  * the provider context of this inner instance with the same library context
 345  * that was used in the EVP call that initiated this recursive call.
 346  */
 347 OSSL_provider_init_fn fips_intern_provider_init;
 348 int fips_intern_provider_init(const OSSL_PROVIDER *provider,
 349                               const OSSL_DISPATCH *in,
 350                               const OSSL_DISPATCH **out,
 351                               void **provctx)
 352 {
 353     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
 354
 355     for (; in->function_id != 0; in++) {
 356         switch (in->function_id) {
 357         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
 358             c_get_libctx = OSSL_get_core_get_library_context(in);
 359             break;
 360         default:
 361             break;
 362         }
 363     }
 364
 365     if (c_get_libctx == NULL)
 366         return 0;
 367
 368     *provctx = c_get_libctx(provider);
 369
 370     /*
 371      * Safety measure...  we should get the library context that was
 372      * created up in OSSL_provider_init().
 373      */
 374     if (*provctx == NULL)
 375         return 0;
 376
 377     *out = intern_dispatch_table;
 378     return 1;
 379 }
 380
 381 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 382 {
 383     /*
 384      * TODO(3.0) the first argument is currently NULL but is expected to
 385      * be passed something else in the future, either an OSSL_PROVIDER or
 386      * a OPENSSL_CTX pointer.
 387      */
 388     c_put_error(NULL, ERR_PACK(lib, func, reason), file, line);
 389     ERR_add_error_data(1, "(in the FIPS module)");
 390 }
 391
 392 void ERR_add_error_data(int num, ...)
 393 {
 394     va_list args;
 395
 396     va_start(args, num);
 397     ERR_add_error_vdata(num, args);
 398     va_end(args);
 399 }
 400
 401 void ERR_add_error_vdata(int num, va_list args)
 402 {
 403     c_add_error_vdata(NULL, num, args);
 404 }
 405
 406 const OSSL_PROVIDER *FIPS_get_provider(OPENSSL_CTX *ctx)
 407 {
 408     FIPS_GLOBAL *fgbl = openssl_ctx_get_data(ctx, OPENSSL_CTX_FIPS_PROV_INDEX,
 409                                              &fips_prov_ossl_ctx_method);
 410
 411     if (fgbl == NULL)
 412         return NULL;
 413
 414     return fgbl->prov;
 415 }