providers/implementations/keymgmt/mac_legacy_kmgmt.c

   1 /*
   2  * Copyright 2020 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 /* We need to use some engine deprecated APIs */
  11 #define OPENSSL_SUPPRESS_DEPRECATED
  12
  13 #include <string.h>
  14 #include <openssl/core_dispatch.h>
  15 #include <openssl/core_names.h>
  16 #include <openssl/params.h>
  17 #include <openssl/err.h>
  18 #include <openssl/evp.h>
  19 #include "openssl/param_build.h"
  20 #include "internal/param_build_set.h"
  21 #include "prov/implementations.h"
  22 #include "prov/providercommon.h"
  23 #include "prov/provider_ctx.h"
  24 #include "prov/macsignature.h"
  25 #include "e_os.h" /* strcasecmp */
  26
  27 static OSSL_FUNC_keymgmt_new_fn mac_new;
  28 static OSSL_FUNC_keymgmt_free_fn mac_free;
  29 static OSSL_FUNC_keymgmt_gen_init_fn mac_gen_init;
  30 static OSSL_FUNC_keymgmt_gen_fn mac_gen;
  31 static OSSL_FUNC_keymgmt_gen_cleanup_fn mac_gen_cleanup;
  32 static OSSL_FUNC_keymgmt_get_params_fn mac_get_params;
  33 static OSSL_FUNC_keymgmt_gettable_params_fn mac_gettable_params;
  34 static OSSL_FUNC_keymgmt_set_params_fn mac_set_params;
  35 static OSSL_FUNC_keymgmt_settable_params_fn mac_settable_params;
  36 static OSSL_FUNC_keymgmt_has_fn mac_has;
  37 static OSSL_FUNC_keymgmt_match_fn mac_match;
  38 static OSSL_FUNC_keymgmt_import_fn mac_import;
  39 static OSSL_FUNC_keymgmt_import_types_fn mac_imexport_types;
  40 static OSSL_FUNC_keymgmt_export_fn mac_export;
  41 static OSSL_FUNC_keymgmt_export_types_fn mac_imexport_types;
  42
  43 struct mac_gen_ctx {
  44     OPENSSL_CTX *libctx;
  45     int selection;
  46     unsigned char *priv_key;
  47     size_t priv_key_len;
  48     PROV_CIPHER cipher;
  49 };
  50
  51 MAC_KEY *mac_key_new(OPENSSL_CTX *libctx, int cmac)
  52 {
  53     MAC_KEY *mackey = OPENSSL_zalloc(sizeof(*mackey));
  54
  55     if (mackey == NULL)
  56         return NULL;
  57
  58     mackey->lock = CRYPTO_THREAD_lock_new();
  59     if (mackey->lock == NULL) {
  60         OPENSSL_free(mackey);
  61         return NULL;
  62     }
  63     mackey->libctx = libctx;
  64     mackey->refcnt = 1;
  65     mackey->cmac = cmac;
  66
  67     return mackey;
  68 }
  69
  70 void mac_key_free(MAC_KEY *mackey)
  71 {
  72     int ref = 0;
  73
  74     if (mackey == NULL)
  75         return;
  76
  77     CRYPTO_DOWN_REF(&mackey->refcnt, &ref, mackey->lock);
  78     if (ref > 0)
  79         return;
  80
  81     OPENSSL_secure_clear_free(mackey->priv_key, mackey->priv_key_len);
  82     OPENSSL_free(mackey->properties);
  83     ossl_prov_cipher_reset(&mackey->cipher);
  84     CRYPTO_THREAD_lock_free(mackey->lock);
  85     OPENSSL_free(mackey);
  86 }
  87
  88 int mac_key_up_ref(MAC_KEY *mackey)
  89 {
  90     int ref = 0;
  91
  92     CRYPTO_UP_REF(&mackey->refcnt, &ref, mackey->lock);
  93     return 1;
  94 }
  95
  96 static void *mac_new(void *provctx)
  97 {
  98     return mac_key_new(PROV_LIBRARY_CONTEXT_OF(provctx), 0);
  99 }
 100
 101 static void *mac_new_cmac(void *provctx)
 102 {
 103     return mac_key_new(PROV_LIBRARY_CONTEXT_OF(provctx), 1);
 104 }
 105
 106 static void mac_free(void *mackey)
 107 {
 108     mac_key_free(mackey);
 109 }
 110
 111 static int mac_has(void *keydata, int selection)
 112 {
 113     MAC_KEY *key = keydata;
 114     int ok = 0;
 115
 116     if (key != NULL) {
 117         /*
 118          * MAC keys always have all the parameters they need (i.e. none).
 119          * Therefore we always return with 1, if asked about parameters.
 120          * Similarly for public keys.
 121          */
 122         ok = 1;
 123
 124         if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
 125             ok = key->priv_key != NULL;
 126     }
 127     return ok;
 128 }
 129
 130 static int mac_match(const void *keydata1, const void *keydata2, int selection)
 131 {
 132     const MAC_KEY *key1 = keydata1;
 133     const MAC_KEY *key2 = keydata2;
 134     int ok = 1;
 135
 136     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
 137         if ((key1->priv_key == NULL && key2->priv_key != NULL)
 138                 || (key1->priv_key != NULL && key2->priv_key == NULL)
 139                 || key1->priv_key_len != key2->priv_key_len
 140                 || (key1->cipher.cipher == NULL && key2->cipher.cipher != NULL)
 141                 || (key1->cipher.cipher != NULL && key2->cipher.cipher == NULL))
 142             ok = 0;
 143         else
 144             ok = ok && (key1->priv_key == NULL /* implies key2->privkey == NULL */
 145                         || CRYPTO_memcmp(key1->priv_key, key2->priv_key,
 146                                          key1->priv_key_len) == 0);
 147         if (key1->cipher.cipher != NULL)
 148             ok = ok && EVP_CIPHER_is_a(key1->cipher.cipher,
 149                                        EVP_CIPHER_name(key2->cipher.cipher));
 150     }
 151     return ok;
 152 }
 153
 154 static int mac_key_fromdata(MAC_KEY *key, const OSSL_PARAM params[])
 155 {
 156     const OSSL_PARAM *p;
 157
 158     p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
 159     if (p != NULL) {
 160         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 161             ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
 162             return 0;
 163         }
 164         OPENSSL_secure_clear_free(key->priv_key, key->priv_key_len);
 165         key->priv_key = OPENSSL_secure_malloc(p->data_size);
 166         if (key->priv_key == NULL) {
 167             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 168             return 0;
 169         }
 170         memcpy(key->priv_key, p->data, p->data_size);
 171         key->priv_key_len = p->data_size;
 172     }
 173
 174     p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);
 175     if (p != NULL) {
 176         if (p->data_type != OSSL_PARAM_UTF8_STRING) {
 177             ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
 178             return 0;
 179         }
 180         OPENSSL_free(key->properties);
 181         key->properties = OPENSSL_strdup(p->data);
 182         if (key->properties == NULL) {
 183             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 184             return 0;
 185         }
 186     }
 187
 188     if (key->cmac && !ossl_prov_cipher_load_from_params(&key->cipher, params,
 189                                                         key->libctx)) {
 190         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
 191         return 0;
 192     }
 193
 194     if (key->priv_key != NULL)
 195         return 1;
 196
 197     return 0;
 198 }
 199
 200 static int mac_import(void *keydata, int selection, const OSSL_PARAM params[])
 201 {
 202     MAC_KEY *key = keydata;
 203
 204     if (key == NULL)
 205         return 0;
 206
 207     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) == 0)
 208         return 0;
 209
 210     return mac_key_fromdata(key, params);
 211 }
 212
 213 static int key_to_params(MAC_KEY *key, OSSL_PARAM_BLD *tmpl,
 214                          OSSL_PARAM params[])
 215 {
 216     if (key == NULL)
 217         return 0;
 218
 219     if (key->priv_key != NULL
 220         && !ossl_param_build_set_octet_string(tmpl, params,
 221                                               OSSL_PKEY_PARAM_PRIV_KEY,
 222                                               key->priv_key, key->priv_key_len))
 223         return 0;
 224
 225     if (key->cipher.cipher != NULL
 226         && !ossl_param_build_set_utf8_string(tmpl, params,
 227                                              OSSL_PKEY_PARAM_CIPHER,
 228                                              EVP_CIPHER_name(key->cipher.cipher)))
 229         return 0;
 230
 231 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
 232     if (key->cipher.engine != NULL
 233         && !ossl_param_build_set_utf8_string(tmpl, params,
 234                                              OSSL_PKEY_PARAM_ENGINE,
 235                                              ENGINE_get_id(key->cipher.engine)))
 236         return 0;
 237 #endif
 238
 239     return 1;
 240 }
 241
 242 static int mac_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
 243                       void *cbarg)
 244 {
 245     MAC_KEY *key = keydata;
 246     OSSL_PARAM_BLD *tmpl;
 247     OSSL_PARAM *params = NULL;
 248     int ret = 0;
 249
 250     if (key == NULL)
 251         return 0;
 252
 253     tmpl = OSSL_PARAM_BLD_new();
 254     if (tmpl == NULL)
 255         return 0;
 256
 257     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
 258          && !key_to_params(key, tmpl, NULL))
 259         goto err;
 260
 261     params = OSSL_PARAM_BLD_to_param(tmpl);
 262     if (params == NULL)
 263         goto err;
 264
 265     ret = param_cb(params, cbarg);
 266     OSSL_PARAM_BLD_free_params(params);
 267 err:
 268     OSSL_PARAM_BLD_free(tmpl);
 269     return ret;
 270 }
 271
 272 static const OSSL_PARAM mac_key_types[] = {
 273     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 274     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
 275     OSSL_PARAM_END
 276 };
 277 static const OSSL_PARAM *mac_imexport_types(int selection)
 278 {
 279     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
 280         return mac_key_types;
 281     return NULL;
 282 }
 283
 284 static const OSSL_PARAM cmac_key_types[] = {
 285     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 286     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
 287     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE, NULL, 0),
 288     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
 289     OSSL_PARAM_END
 290 };
 291 static const OSSL_PARAM *cmac_imexport_types(int selection)
 292 {
 293     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
 294         return cmac_key_types;
 295     return NULL;
 296 }
 297
 298 static int mac_get_params(void *key, OSSL_PARAM params[])
 299 {
 300     return key_to_params(key, NULL, params);
 301 }
 302
 303 static const OSSL_PARAM *mac_gettable_params(void *provctx)
 304 {
 305     static const OSSL_PARAM gettable_params[] = {
 306         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 307         OSSL_PARAM_END
 308     };
 309     return gettable_params;
 310 }
 311
 312 static const OSSL_PARAM *cmac_gettable_params(void *provctx)
 313 {
 314     static const OSSL_PARAM gettable_params[] = {
 315         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 316         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
 317         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE, NULL, 0),
 318         OSSL_PARAM_END
 319     };
 320     return gettable_params;
 321 }
 322
 323
 324 static int mac_set_params(void *keydata, const OSSL_PARAM params[])
 325 {
 326     MAC_KEY *key = keydata;
 327     const OSSL_PARAM *p;
 328
 329     if (key == NULL)
 330         return 0;
 331
 332     p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
 333     if (p != NULL)
 334         return mac_key_fromdata(key, params);
 335
 336     return 1;
 337 }
 338
 339 static const OSSL_PARAM *mac_settable_params(void *provctx)
 340 {
 341     static const OSSL_PARAM settable_params[] = {
 342         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 343         OSSL_PARAM_END
 344     };
 345     return settable_params;
 346 }
 347
 348 static void *mac_gen_init(void *provctx, int selection)
 349 {
 350     OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
 351     struct mac_gen_ctx *gctx = NULL;
 352
 353     if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
 354         gctx->libctx = libctx;
 355         gctx->selection = selection;
 356     }
 357     return gctx;
 358 }
 359
 360 static int mac_gen_set_params(void *genctx, const OSSL_PARAM params[])
 361 {
 362     struct mac_gen_ctx *gctx = genctx;
 363     const OSSL_PARAM *p;
 364
 365     if (gctx == NULL)
 366         return 0;
 367
 368     p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
 369     if (p != NULL) {
 370         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 371             ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
 372             return 0;
 373         }
 374         gctx->priv_key = OPENSSL_secure_malloc(p->data_size);
 375         if (gctx->priv_key == NULL) {
 376             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 377             return 0;
 378         }
 379         memcpy(gctx->priv_key, p->data, p->data_size);
 380         gctx->priv_key_len = p->data_size;
 381     }
 382
 383     return 1;
 384 }
 385
 386 static int cmac_gen_set_params(void *genctx, const OSSL_PARAM params[])
 387 {
 388     struct mac_gen_ctx *gctx = genctx;
 389
 390     if (!mac_gen_set_params(genctx, params))
 391         return 0;
 392
 393     if (!ossl_prov_cipher_load_from_params(&gctx->cipher, params,
 394                                            gctx->libctx)) {
 395         ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
 396         return 0;
 397     }
 398
 399     return 1;
 400 }
 401
 402 static const OSSL_PARAM *mac_gen_settable_params(void *provctx)
 403 {
 404     static OSSL_PARAM settable[] = {
 405         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 406         OSSL_PARAM_END
 407     };
 408     return settable;
 409 }
 410
 411 static const OSSL_PARAM *cmac_gen_settable_params(void *provctx)
 412 {
 413     static OSSL_PARAM settable[] = {
 414         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 415         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
 416         OSSL_PARAM_END
 417     };
 418     return settable;
 419 }
 420
 421 static void *mac_gen(void *genctx, OSSL_CALLBACK *cb, void *cbarg)
 422 {
 423     struct mac_gen_ctx *gctx = genctx;
 424     MAC_KEY *key;
 425
 426     if (gctx == NULL)
 427         return NULL;
 428
 429     if ((key = mac_key_new(gctx->libctx, 0)) == NULL) {
 430         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 431         return NULL;
 432     }
 433
 434     /* If we're doing parameter generation then we just return a blank key */
 435     if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
 436         return key;
 437
 438     if (gctx->priv_key == NULL) {
 439         ERR_raise(ERR_LIB_PROV, EVP_R_INVALID_KEY);
 440         mac_key_free(key);
 441         return NULL;
 442     }
 443
 444     /*
 445      * This is horrible but required for backwards compatibility. We don't
 446      * actually do real key generation at all. We simply copy the key that was
 447      * previously set in the gctx. Hopefully at some point in the future all
 448      * of this can be removed and we will only support the EVP_KDF APIs.
 449      */
 450     if (!ossl_prov_cipher_copy(&key->cipher, &gctx->cipher)) {
 451         ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
 452         return NULL;
 453     }
 454     ossl_prov_cipher_reset(&gctx->cipher);
 455     key->priv_key = gctx->priv_key;
 456     key->priv_key_len = gctx->priv_key_len;
 457     gctx->priv_key_len = 0;
 458     gctx->priv_key = NULL;
 459
 460     return key;
 461 }
 462
 463 static void mac_gen_cleanup(void *genctx)
 464 {
 465     struct mac_gen_ctx *gctx = genctx;
 466
 467     OPENSSL_secure_clear_free(gctx->priv_key, gctx->priv_key_len);
 468     ossl_prov_cipher_reset(&gctx->cipher);
 469     OPENSSL_free(gctx);
 470 }
 471
 472 const OSSL_DISPATCH mac_keymgmt_functions[] = {
 473     { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))mac_new },
 474     { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))mac_free },
 475     { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))mac_get_params },
 476     { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))mac_gettable_params },
 477     { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))mac_set_params },
 478     { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))mac_settable_params },
 479     { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))mac_has },
 480     { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))mac_match },
 481     { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))mac_import },
 482     { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))mac_imexport_types },
 483     { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))mac_export },
 484     { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))mac_imexport_types },
 485     { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))mac_gen_init },
 486     { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))mac_gen_set_params },
 487     { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
 488         (void (*)(void))mac_gen_settable_params },
 489     { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))mac_gen },
 490     { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))mac_gen_cleanup },
 491     { 0, NULL }
 492 };
 493
 494 const OSSL_DISPATCH cmac_keymgmt_functions[] = {
 495     { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))mac_new_cmac },
 496     { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))mac_free },
 497     { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))mac_get_params },
 498     { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))cmac_gettable_params },
 499     { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))mac_set_params },
 500     { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))mac_settable_params },
 501     { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))mac_has },
 502     { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))mac_match },
 503     { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))mac_import },
 504     { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))cmac_imexport_types },
 505     { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))mac_export },
 506     { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))cmac_imexport_types },
 507     { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))mac_gen_init },
 508     { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))cmac_gen_set_params },
 509     { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
 510         (void (*)(void))cmac_gen_settable_params },
 511     { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))mac_gen },
 512     { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))mac_gen_cleanup },
 513     { 0, NULL }
 514 };