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, importfncnt = 0, exportfncnt = 0;
  42
  43     if ((keymgmt = keymgmt_new()) == NULL) {
  44         EVP_KEYMGMT_free(keymgmt);
  45         return NULL;
  46     }
  47     keymgmt->name_id = name_id;
  48
  49     for (; fns->function_id != 0; fns++) {
  50         switch (fns->function_id) {
  51         case OSSL_FUNC_KEYMGMT_NEW:
  52             if (keymgmt->new == NULL)
  53                 keymgmt->new = OSSL_get_OP_keymgmt_new(fns);
  54             break;
  55         case OSSL_FUNC_KEYMGMT_FREE:
  56             if (keymgmt->free == NULL)
  57                 keymgmt->free = OSSL_get_OP_keymgmt_free(fns);
  58             break;
  59         case OSSL_FUNC_KEYMGMT_GET_PARAMS:
  60             if (keymgmt->get_params == NULL) {
  61                 getparamfncnt++;
  62                 keymgmt->get_params = OSSL_get_OP_keymgmt_get_params(fns);
  63             }
  64             break;
  65         case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS:
  66             if (keymgmt->gettable_params == NULL) {
  67                 getparamfncnt++;
  68                 keymgmt->gettable_params =
  69                     OSSL_get_OP_keymgmt_gettable_params(fns);
  70             }
  71             break;
  72          case OSSL_FUNC_KEYMGMT_SET_PARAMS:
  73             if (keymgmt->set_params == NULL) {
  74                 setparamfncnt++;
  75                 keymgmt->set_params = OSSL_get_OP_keymgmt_set_params(fns);
  76             }
  77             break;
  78         case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS:
  79             if (keymgmt->settable_params == NULL) {
  80                 setparamfncnt++;
  81                 keymgmt->settable_params =
  82                     OSSL_get_OP_keymgmt_settable_params(fns);
  83             }
  84             break;
  85         case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME:
  86             if (keymgmt->query_operation_name == NULL)
  87                 keymgmt->query_operation_name =
  88                     OSSL_get_OP_keymgmt_query_operation_name(fns);
  89             break;
  90         case OSSL_FUNC_KEYMGMT_HAS:
  91             if (keymgmt->has == NULL)
  92                 keymgmt->has = OSSL_get_OP_keymgmt_has(fns);
  93             break;
  94         case OSSL_FUNC_KEYMGMT_VALIDATE:
  95             if (keymgmt->validate == NULL)
  96                 keymgmt->validate = OSSL_get_OP_keymgmt_validate(fns);
  97             break;
  98         case OSSL_FUNC_KEYMGMT_MATCH:
  99             if (keymgmt->match == NULL)
 100                 keymgmt->match = OSSL_get_OP_keymgmt_match(fns);
 101             break;
 102         case OSSL_FUNC_KEYMGMT_IMPORT:
 103             if (keymgmt->import == NULL) {
 104                 importfncnt++;
 105                 keymgmt->import = OSSL_get_OP_keymgmt_import(fns);
 106             }
 107             break;
 108         case OSSL_FUNC_KEYMGMT_IMPORT_TYPES:
 109             if (keymgmt->import_types == NULL) {
 110                 importfncnt++;
 111                 keymgmt->import_types = OSSL_get_OP_keymgmt_import_types(fns);
 112             }
 113             break;
 114         case OSSL_FUNC_KEYMGMT_EXPORT:
 115             if (keymgmt->export == NULL) {
 116                 exportfncnt++;
 117                 keymgmt->export = OSSL_get_OP_keymgmt_export(fns);
 118             }
 119             break;
 120         case OSSL_FUNC_KEYMGMT_EXPORT_TYPES:
 121             if (keymgmt->export_types == NULL) {
 122                 exportfncnt++;
 123                 keymgmt->export_types = OSSL_get_OP_keymgmt_export_types(fns);
 124             }
 125             break;
 126         }
 127     }
 128     /*
 129      * Try to check that the method is sensible.
 130      * At least one constructor and the destructor are MANDATORY
 131      * The functions 'has' is MANDATORY
 132      * It makes no sense being able to free stuff if you can't create it.
 133      * It makes no sense providing OSSL_PARAM descriptors for import and
 134      * export if you can't import or export.
 135      */
 136     if (keymgmt->free == NULL
 137         || keymgmt->new == NULL
 138         || keymgmt->has == NULL
 139         || (getparamfncnt != 0 && getparamfncnt != 2)
 140         || (setparamfncnt != 0 && setparamfncnt != 2)
 141         || (importfncnt != 0 && importfncnt != 2)
 142         || (exportfncnt != 0 && exportfncnt != 2)) {
 143         EVP_KEYMGMT_free(keymgmt);
 144         EVPerr(0, EVP_R_INVALID_PROVIDER_FUNCTIONS);
 145         return NULL;
 146     }
 147     keymgmt->prov = prov;
 148     if (prov != NULL)
 149         ossl_provider_up_ref(prov);
 150
 151     return keymgmt;
 152 }
 153
 154 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
 155                                          const char *properties)
 156 {
 157     return evp_generic_fetch_by_number(ctx,
 158                                        OSSL_OP_KEYMGMT, name_id, properties,
 159                                        keymgmt_from_dispatch,
 160                                        (int (*)(void *))EVP_KEYMGMT_up_ref,
 161                                        (void (*)(void *))EVP_KEYMGMT_free);
 162 }
 163
 164 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
 165                                const char *properties)
 166 {
 167     return evp_generic_fetch(ctx, OSSL_OP_KEYMGMT, algorithm, properties,
 168                              keymgmt_from_dispatch,
 169                              (int (*)(void *))EVP_KEYMGMT_up_ref,
 170                              (void (*)(void *))EVP_KEYMGMT_free);
 171 }
 172
 173 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT *keymgmt)
 174 {
 175     int ref = 0;
 176
 177     CRYPTO_UP_REF(&keymgmt->refcnt, &ref, keymgmt->lock);
 178     return 1;
 179 }
 180
 181 void EVP_KEYMGMT_free(EVP_KEYMGMT *keymgmt)
 182 {
 183     int ref = 0;
 184
 185     if (keymgmt == NULL)
 186         return;
 187
 188     CRYPTO_DOWN_REF(&keymgmt->refcnt, &ref, keymgmt->lock);
 189     if (ref > 0)
 190         return;
 191     ossl_provider_free(keymgmt->prov);
 192     CRYPTO_THREAD_lock_free(keymgmt->lock);
 193     OPENSSL_free(keymgmt);
 194 }
 195
 196 const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt)
 197 {
 198     return keymgmt->prov;
 199 }
 200
 201 int EVP_KEYMGMT_number(const EVP_KEYMGMT *keymgmt)
 202 {
 203     return keymgmt->name_id;
 204 }
 205
 206 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name)
 207 {
 208     return evp_is_a(keymgmt->prov, keymgmt->name_id, NULL, name);
 209 }
 210
 211 void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX *libctx,
 212                                  void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
 213                                  void *arg)
 214 {
 215     evp_generic_do_all(libctx, OSSL_OP_KEYMGMT,
 216                        (void (*)(void *, void *))fn, arg,
 217                        keymgmt_from_dispatch,
 218                        (void (*)(void *))EVP_KEYMGMT_free);
 219 }
 220
 221 void EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT *keymgmt,
 222                               void (*fn)(const char *name, void *data),
 223                               void *data)
 224 {
 225     if (keymgmt->prov != NULL)
 226         evp_names_do_all(keymgmt->prov, keymgmt->name_id, fn, data);
 227 }
 228
 229 /*
 230  * Internal API that interfaces with the method function pointers
 231  */
 232 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt)
 233 {
 234     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 235
 236     /*
 237      * TODO(3.0) 'new' is currently mandatory on its own, but when new
 238      * constructors appear, it won't be quite as mandatory, so we have
 239      * a check for future cases.
 240      */
 241     if (keymgmt->new == NULL)
 242         return NULL;
 243     return keymgmt->new(provctx);
 244 }
 245
 246 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keydata)
 247 {
 248     /* This is mandatory, no need to check for its presence */
 249     keymgmt->free(keydata);
 250 }
 251
 252 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 253                            OSSL_PARAM params[])
 254 {
 255     if (keymgmt->get_params == NULL)
 256         return 1;
 257     return keymgmt->get_params(keydata, params);
 258 }
 259
 260 const OSSL_PARAM *evp_keymgmt_gettable_params(const EVP_KEYMGMT *keymgmt)
 261 {
 262     if (keymgmt->gettable_params == NULL)
 263         return NULL;
 264     return keymgmt->gettable_params();
 265 }
 266
 267 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 268                            const OSSL_PARAM params[])
 269 {
 270     if (keymgmt->set_params == NULL)
 271         return 1;
 272     return keymgmt->set_params(keydata, params);
 273 }
 274
 275 const OSSL_PARAM *evp_keymgmt_settable_params(const EVP_KEYMGMT *keymgmt)
 276 {
 277     if (keymgmt->settable_params == NULL)
 278         return NULL;
 279     return keymgmt->settable_params();
 280 }
 281
 282 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keydata, int selection)
 283 {
 284     /* This is mandatory, no need to check for its presence */
 285     return keymgmt->has(keydata, selection);
 286 }
 287
 288 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
 289                          int selection)
 290 {
 291     /* We assume valid if the implementation doesn't have a function */
 292     if (keymgmt->validate == NULL)
 293         return 1;
 294     return keymgmt->validate(keydata, selection);
 295 }
 296
 297 int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
 298                       const void *keydata1, const void *keydata2,
 299                       int selection)
 300 {
 301     /* We assume no match if the implementation doesn't have a function */
 302     if (keymgmt->match == NULL)
 303         return 0;
 304     return keymgmt->match(keydata1, keydata2, selection);
 305 }
 306
 307 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
 308                        int selection, const OSSL_PARAM params[])
 309 {
 310     if (keymgmt->import == NULL)
 311         return 0;
 312     return keymgmt->import(keydata, selection, params);
 313 }
 314
 315 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
 316                                            int selection)
 317 {
 318     if (keymgmt->import_types == NULL)
 319         return NULL;
 320     return keymgmt->import_types(selection);
 321 }
 322
 323 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
 324                        int selection, OSSL_CALLBACK *param_cb, void *cbarg)
 325 {
 326     if (keymgmt->export == NULL)
 327         return 0;
 328     return keymgmt->export(keydata, selection, param_cb, cbarg);
 329 }
 330
 331 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
 332                                            int selection)
 333 {
 334     if (keymgmt->export_types == NULL)
 335         return NULL;
 336     return keymgmt->export_types(selection);
 337 }