crypto/evp/keymgmt_meth.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 <openssl/crypto.h>
  11 #include <openssl/core_numbers.h>
  12 #include <openssl/evp.h>
  13 #include <openssl/err.h>
  14 #include "internal/provider.h"
  15 #include "internal/refcount.h"
  16 #include "crypto/evp.h"
  17 #include "evp_local.h"
  18
  19
  20 static void *keymgmt_new(void)
  21 {
  22     EVP_KEYMGMT *keymgmt = NULL;
  23
  24     if ((keymgmt = OPENSSL_zalloc(sizeof(*keymgmt))) == NULL
  25         || (keymgmt->lock = CRYPTO_THREAD_lock_new()) == NULL) {
  26         EVP_KEYMGMT_free(keymgmt);
  27         EVPerr(0, ERR_R_MALLOC_FAILURE);
  28         return NULL;
  29     }
  30
  31     keymgmt->refcnt = 1;
  32
  33     return keymgmt;
  34 }
  35
  36 static void *keymgmt_from_dispatch(int name_id,
  37                                    const OSSL_DISPATCH *fns,
  38                                    OSSL_PROVIDER *prov)
  39 {
  40     EVP_KEYMGMT *keymgmt = NULL;
  41     int setparamfncnt = 0, getparamfncnt = 0, setgenparamfncnt = 0;
  42     int importfncnt = 0, exportfncnt = 0;
  43
  44     if ((keymgmt = keymgmt_new()) == NULL) {
  45         EVP_KEYMGMT_free(keymgmt);
  46         return NULL;
  47     }
  48     keymgmt->name_id = name_id;
  49
  50     for (; fns->function_id != 0; fns++) {
  51         switch (fns->function_id) {
  52         case OSSL_FUNC_KEYMGMT_NEW:
  53             if (keymgmt->new == NULL)
  54                 keymgmt->new = OSSL_get_OP_keymgmt_new(fns);
  55             break;
  56         case OSSL_FUNC_KEYMGMT_GEN_INIT:
  57             if (keymgmt->gen_init == NULL)
  58                 keymgmt->gen_init = OSSL_get_OP_keymgmt_gen_init(fns);
  59             break;
  60         case OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE:
  61             if (keymgmt->gen_set_template == NULL)
  62                 keymgmt->gen_set_template =
  63                     OSSL_get_OP_keymgmt_gen_set_template(fns);
  64             break;
  65         case OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS:
  66             if (keymgmt->gen_set_params == NULL) {
  67                 setgenparamfncnt++;
  68                 keymgmt->gen_set_params =
  69                     OSSL_get_OP_keymgmt_gen_set_params(fns);
  70             }
  71             break;
  72         case OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS:
  73             if (keymgmt->gen_settable_params == NULL) {
  74                 setgenparamfncnt++;
  75                 keymgmt->gen_settable_params =
  76                     OSSL_get_OP_keymgmt_gen_settable_params(fns);
  77             }
  78             break;
  79         case OSSL_FUNC_KEYMGMT_GEN:
  80             if (keymgmt->gen == NULL)
  81                 keymgmt->gen = OSSL_get_OP_keymgmt_gen(fns);
  82             break;
  83         case OSSL_FUNC_KEYMGMT_GEN_CLEANUP:
  84             if (keymgmt->gen_cleanup == NULL)
  85                 keymgmt->gen_cleanup = OSSL_get_OP_keymgmt_gen_cleanup(fns);
  86             break;
  87         case OSSL_FUNC_KEYMGMT_FREE:
  88             if (keymgmt->free == NULL)
  89                 keymgmt->free = OSSL_get_OP_keymgmt_free(fns);
  90             break;
  91         case OSSL_FUNC_KEYMGMT_GET_PARAMS:
  92             if (keymgmt->get_params == NULL) {
  93                 getparamfncnt++;
  94                 keymgmt->get_params = OSSL_get_OP_keymgmt_get_params(fns);
  95             }
  96             break;
  97         case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS:
  98             if (keymgmt->gettable_params == NULL) {
  99                 getparamfncnt++;
 100                 keymgmt->gettable_params =
 101                     OSSL_get_OP_keymgmt_gettable_params(fns);
 102             }
 103             break;
 104          case OSSL_FUNC_KEYMGMT_SET_PARAMS:
 105             if (keymgmt->set_params == NULL) {
 106                 setparamfncnt++;
 107                 keymgmt->set_params = OSSL_get_OP_keymgmt_set_params(fns);
 108             }
 109             break;
 110         case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS:
 111             if (keymgmt->settable_params == NULL) {
 112                 setparamfncnt++;
 113                 keymgmt->settable_params =
 114                     OSSL_get_OP_keymgmt_settable_params(fns);
 115             }
 116             break;
 117         case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME:
 118             if (keymgmt->query_operation_name == NULL)
 119                 keymgmt->query_operation_name =
 120                     OSSL_get_OP_keymgmt_query_operation_name(fns);
 121             break;
 122         case OSSL_FUNC_KEYMGMT_HAS:
 123             if (keymgmt->has == NULL)
 124                 keymgmt->has = OSSL_get_OP_keymgmt_has(fns);
 125             break;
 126         case OSSL_FUNC_KEYMGMT_VALIDATE:
 127             if (keymgmt->validate == NULL)
 128                 keymgmt->validate = OSSL_get_OP_keymgmt_validate(fns);
 129             break;
 130         case OSSL_FUNC_KEYMGMT_MATCH:
 131             if (keymgmt->match == NULL)
 132                 keymgmt->match = OSSL_get_OP_keymgmt_match(fns);
 133             break;
 134         case OSSL_FUNC_KEYMGMT_IMPORT:
 135             if (keymgmt->import == NULL) {
 136                 importfncnt++;
 137                 keymgmt->import = OSSL_get_OP_keymgmt_import(fns);
 138             }
 139             break;
 140         case OSSL_FUNC_KEYMGMT_IMPORT_TYPES:
 141             if (keymgmt->import_types == NULL) {
 142                 importfncnt++;
 143                 keymgmt->import_types = OSSL_get_OP_keymgmt_import_types(fns);
 144             }
 145             break;
 146         case OSSL_FUNC_KEYMGMT_EXPORT:
 147             if (keymgmt->export == NULL) {
 148                 exportfncnt++;
 149                 keymgmt->export = OSSL_get_OP_keymgmt_export(fns);
 150             }
 151             break;
 152         case OSSL_FUNC_KEYMGMT_EXPORT_TYPES:
 153             if (keymgmt->export_types == NULL) {
 154                 exportfncnt++;
 155                 keymgmt->export_types = OSSL_get_OP_keymgmt_export_types(fns);
 156             }
 157             break;
 158         }
 159     }
 160     /*
 161      * Try to check that the method is sensible.
 162      * At least one constructor and the destructor are MANDATORY
 163      * The functions 'has' is MANDATORY
 164      * It makes no sense being able to free stuff if you can't create it.
 165      * It makes no sense providing OSSL_PARAM descriptors for import and
 166      * export if you can't import or export.
 167      */
 168     if (keymgmt->free == NULL
 169         || (keymgmt->new == NULL && keymgmt->gen == NULL)
 170         || keymgmt->has == NULL
 171         || (getparamfncnt != 0 && getparamfncnt != 2)
 172         || (setparamfncnt != 0 && setparamfncnt != 2)
 173         || (setgenparamfncnt != 0 && setgenparamfncnt != 2)
 174         || (importfncnt != 0 && importfncnt != 2)
 175         || (exportfncnt != 0 && exportfncnt != 2)
 176         || (keymgmt->gen != NULL
 177             && (keymgmt->gen_init == NULL
 178                 || keymgmt->gen_cleanup == NULL))) {
 179         EVP_KEYMGMT_free(keymgmt);
 180         EVPerr(0, EVP_R_INVALID_PROVIDER_FUNCTIONS);
 181         return NULL;
 182     }
 183     keymgmt->prov = prov;
 184     if (prov != NULL)
 185         ossl_provider_up_ref(prov);
 186
 187     return keymgmt;
 188 }
 189
 190 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
 191                                          const char *properties)
 192 {
 193     return evp_generic_fetch_by_number(ctx,
 194                                        OSSL_OP_KEYMGMT, name_id, properties,
 195                                        keymgmt_from_dispatch,
 196                                        (int (*)(void *))EVP_KEYMGMT_up_ref,
 197                                        (void (*)(void *))EVP_KEYMGMT_free);
 198 }
 199
 200 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
 201                                const char *properties)
 202 {
 203     return evp_generic_fetch(ctx, OSSL_OP_KEYMGMT, algorithm, properties,
 204                              keymgmt_from_dispatch,
 205                              (int (*)(void *))EVP_KEYMGMT_up_ref,
 206                              (void (*)(void *))EVP_KEYMGMT_free);
 207 }
 208
 209 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT *keymgmt)
 210 {
 211     int ref = 0;
 212
 213     CRYPTO_UP_REF(&keymgmt->refcnt, &ref, keymgmt->lock);
 214     return 1;
 215 }
 216
 217 void EVP_KEYMGMT_free(EVP_KEYMGMT *keymgmt)
 218 {
 219     int ref = 0;
 220
 221     if (keymgmt == NULL)
 222         return;
 223
 224     CRYPTO_DOWN_REF(&keymgmt->refcnt, &ref, keymgmt->lock);
 225     if (ref > 0)
 226         return;
 227     ossl_provider_free(keymgmt->prov);
 228     CRYPTO_THREAD_lock_free(keymgmt->lock);
 229     OPENSSL_free(keymgmt);
 230 }
 231
 232 const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt)
 233 {
 234     return keymgmt->prov;
 235 }
 236
 237 int EVP_KEYMGMT_number(const EVP_KEYMGMT *keymgmt)
 238 {
 239     return keymgmt->name_id;
 240 }
 241
 242 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name)
 243 {
 244     return evp_is_a(keymgmt->prov, keymgmt->name_id, NULL, name);
 245 }
 246
 247 void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX *libctx,
 248                                  void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
 249                                  void *arg)
 250 {
 251     evp_generic_do_all(libctx, OSSL_OP_KEYMGMT,
 252                        (void (*)(void *, void *))fn, arg,
 253                        keymgmt_from_dispatch,
 254                        (void (*)(void *))EVP_KEYMGMT_free);
 255 }
 256
 257 void EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT *keymgmt,
 258                               void (*fn)(const char *name, void *data),
 259                               void *data)
 260 {
 261     if (keymgmt->prov != NULL)
 262         evp_names_do_all(keymgmt->prov, keymgmt->name_id, fn, data);
 263 }
 264
 265 /*
 266  * Internal API that interfaces with the method function pointers
 267  */
 268 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt)
 269 {
 270     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 271
 272     /*
 273      * TODO(3.0) 'new' is currently mandatory on its own, but when new
 274      * constructors appear, it won't be quite as mandatory, so we have
 275      * a check for future cases.
 276      */
 277     if (keymgmt->new == NULL)
 278         return NULL;
 279     return keymgmt->new(provctx);
 280 }
 281
 282 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keydata)
 283 {
 284     /* This is mandatory, no need to check for its presence */
 285     keymgmt->free(keydata);
 286 }
 287
 288 void *evp_keymgmt_gen_init(const EVP_KEYMGMT *keymgmt, int selection)
 289 {
 290     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 291
 292     if (keymgmt->gen_init == NULL)
 293         return NULL;
 294     return keymgmt->gen_init(provctx, selection);
 295 }
 296
 297 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT *keymgmt, void *genctx,
 298                                  void *template)
 299 {
 300     if (keymgmt->gen_set_template == NULL)
 301         return 0;
 302     return keymgmt->gen_set_template(genctx, template);
 303 }
 304
 305 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT *keymgmt, void *genctx,
 306                                const OSSL_PARAM params[])
 307 {
 308     if (keymgmt->gen_set_params == NULL)
 309         return 0;
 310     return keymgmt->gen_set_params(genctx, params);
 311 }
 312
 313 const OSSL_PARAM *evp_keymgmt_gen_settable_params(const EVP_KEYMGMT *keymgmt)
 314 {
 315     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 316
 317     if (keymgmt->gen_settable_params == NULL)
 318         return NULL;
 319     return keymgmt->gen_settable_params(provctx);
 320 }
 321
 322 void *evp_keymgmt_gen(const EVP_KEYMGMT *keymgmt, void *genctx,
 323                       OSSL_CALLBACK *cb, void *cbarg)
 324 {
 325     if (keymgmt->gen == NULL)
 326         return NULL;
 327     return keymgmt->gen(genctx, cb, cbarg);
 328 }
 329
 330 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT *keymgmt, void *genctx)
 331 {
 332     if (keymgmt->gen != NULL)
 333         keymgmt->gen_cleanup(genctx);
 334 }
 335
 336 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 337                            OSSL_PARAM params[])
 338 {
 339     if (keymgmt->get_params == NULL)
 340         return 1;
 341     return keymgmt->get_params(keydata, params);
 342 }
 343
 344 const OSSL_PARAM *evp_keymgmt_gettable_params(const EVP_KEYMGMT *keymgmt)
 345 {
 346     if (keymgmt->gettable_params == NULL)
 347         return NULL;
 348     return keymgmt->gettable_params();
 349 }
 350
 351 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 352                            const OSSL_PARAM params[])
 353 {
 354     if (keymgmt->set_params == NULL)
 355         return 1;
 356     return keymgmt->set_params(keydata, params);
 357 }
 358
 359 const OSSL_PARAM *evp_keymgmt_settable_params(const EVP_KEYMGMT *keymgmt)
 360 {
 361     if (keymgmt->settable_params == NULL)
 362         return NULL;
 363     return keymgmt->settable_params();
 364 }
 365
 366 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keydata, int selection)
 367 {
 368     /* This is mandatory, no need to check for its presence */
 369     return keymgmt->has(keydata, selection);
 370 }
 371
 372 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
 373                          int selection)
 374 {
 375     /* We assume valid if the implementation doesn't have a function */
 376     if (keymgmt->validate == NULL)
 377         return 1;
 378     return keymgmt->validate(keydata, selection);
 379 }
 380
 381 int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
 382                       const void *keydata1, const void *keydata2,
 383                       int selection)
 384 {
 385     /* We assume no match if the implementation doesn't have a function */
 386     if (keymgmt->match == NULL)
 387         return 0;
 388     return keymgmt->match(keydata1, keydata2, selection);
 389 }
 390
 391 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
 392                        int selection, const OSSL_PARAM params[])
 393 {
 394     if (keymgmt->import == NULL)
 395         return 0;
 396     return keymgmt->import(keydata, selection, params);
 397 }
 398
 399 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
 400                                            int selection)
 401 {
 402     if (keymgmt->import_types == NULL)
 403         return NULL;
 404     return keymgmt->import_types(selection);
 405 }
 406
 407 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
 408                        int selection, OSSL_CALLBACK *param_cb, void *cbarg)
 409 {
 410     if (keymgmt->export == NULL)
 411         return 0;
 412     return keymgmt->export(keydata, selection, param_cb, cbarg);
 413 }
 414
 415 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
 416                                            int selection)
 417 {
 418     if (keymgmt->export_types == NULL)
 419         return NULL;
 420     return keymgmt->export_types(selection);
 421 }
 422
 423 int evp_keymgmt_copy(const EVP_KEYMGMT *keymgmt,
 424                      void *keydata_to, const void *keydata_from,
 425                      int selection)
 426 {
 427     /* We assume no copy if the implementation doesn't have a function */
 428     if (keymgmt->copy == NULL)
 429         return 0;
 430     return keymgmt->copy(keydata_to, keydata_from, selection);
 431 }