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