providers/legacyprov.c

   1 /*
   2  * Copyright 2019-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 #include <string.h>
  11 #include <stdio.h>
  12 #include <openssl/core.h>
  13 #include <openssl/core_dispatch.h>
  14 #include <openssl/core_names.h>
  15 #include <openssl/params.h>
  16 #include "prov/provider_ctx.h"
  17 #include "prov/implementations.h"
  18
  19 /*
  20  * Forward declarations to ensure that interface functions are correctly
  21  * defined.
  22  */
  23 static OSSL_FUNC_provider_gettable_params_fn legacy_gettable_params;
  24 static OSSL_FUNC_provider_get_params_fn legacy_get_params;
  25 static OSSL_FUNC_provider_query_operation_fn legacy_query;
  26
  27 #define ALG(NAMES, FUNC) { NAMES, "provider=legacy", FUNC }
  28
  29 #ifdef STATIC_LEGACY
  30 OSSL_provider_init_fn ossl_legacy_provider_init;
  31 # define OSSL_provider_init ossl_legacy_provider_init
  32 #endif
  33
  34 /* Functions provided by the core */
  35 static OSSL_FUNC_core_gettable_params_fn *c_gettable_params = NULL;
  36 static OSSL_FUNC_core_get_params_fn *c_get_params = NULL;
  37
  38 /* Parameters we provide to the core */
  39 static const OSSL_PARAM legacy_param_types[] = {
  40     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
  41     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
  42     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
  43     OSSL_PARAM_END
  44 };
  45
  46 static const OSSL_PARAM *legacy_gettable_params(void *provctx)
  47 {
  48     return legacy_param_types;
  49 }
  50
  51 static int legacy_get_params(void *provctx, OSSL_PARAM params[])
  52 {
  53     OSSL_PARAM *p;
  54
  55     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
  56     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL Legacy Provider"))
  57         return 0;
  58     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
  59     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
  60         return 0;
  61     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
  62     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
  63         return 0;
  64     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_STATUS);
  65     if (p != NULL && !OSSL_PARAM_set_uint(p, 1))
  66         return 0;
  67     return 1;
  68 }
  69
  70 static const OSSL_ALGORITHM legacy_digests[] = {
  71 #ifndef OPENSSL_NO_MD2
  72     ALG("MD2", md2_functions),
  73 #endif
  74 #ifndef OPENSSL_NO_MD4
  75     ALG("MD4", md4_functions),
  76 #endif
  77 #ifndef OPENSSL_NO_MDC2
  78     ALG("MDC2", mdc2_functions),
  79 #endif /* OPENSSL_NO_MDC2 */
  80 #ifndef OPENSSL_NO_WHIRLPOOL
  81     ALG("WHIRLPOOL", wp_functions),
  82 #endif /* OPENSSL_NO_WHIRLPOOL */
  83 #ifndef OPENSSL_NO_RMD160
  84     ALG("RIPEMD-160:RIPEMD160:RIPEMD:RMD160", ripemd160_functions),
  85 #endif /* OPENSSL_NO_RMD160 */
  86     { NULL, NULL, NULL }
  87 };
  88
  89 static const OSSL_ALGORITHM legacy_ciphers[] = {
  90 #ifndef OPENSSL_NO_CAST
  91     ALG("CAST5-ECB", cast5128ecb_functions),
  92     ALG("CAST5-CBC:CAST-CBC:CAST", cast5128cbc_functions),
  93     ALG("CAST5-OFB", cast5128ofb64_functions),
  94     ALG("CAST5-CFB", cast5128cfb64_functions),
  95 #endif /* OPENSSL_NO_CAST */
  96 #ifndef OPENSSL_NO_BF
  97     ALG("BF-ECB", blowfish128ecb_functions),
  98     ALG("BF-CBC:BF:BLOWFISH", blowfish128cbc_functions),
  99     ALG("BF-OFB", blowfish64ofb64_functions),
 100     ALG("BF-CFB", blowfish64cfb64_functions),
 101 #endif /* OPENSSL_NO_BF */
 102 #ifndef OPENSSL_NO_IDEA
 103     ALG("IDEA-ECB", idea128ecb_functions),
 104     ALG("IDEA-CBC:IDEA", idea128cbc_functions),
 105     ALG("IDEA-OFB:IDEA-OFB64", idea128ofb64_functions),
 106     ALG("IDEA-CFB:IDEA-CFB64", idea128cfb64_functions),
 107 #endif /* OPENSSL_NO_IDEA */
 108 #ifndef OPENSSL_NO_SEED
 109     ALG("SEED-ECB", seed128ecb_functions),
 110     ALG("SEED-CBC:SEED", seed128cbc_functions),
 111     ALG("SEED-OFB:SEED-OFB128", seed128ofb128_functions),
 112     ALG("SEED-CFB:SEED-CFB128", seed128cfb128_functions),
 113 #endif /* OPENSSL_NO_SEED */
 114 #ifndef OPENSSL_NO_RC2
 115     ALG("RC2-ECB", rc2128ecb_functions),
 116     ALG("RC2-CBC:RC2:RC2-128", rc2128cbc_functions),
 117     ALG("RC2-40-CBC:RC2-40", rc240cbc_functions),
 118     ALG("RC2-64-CBC:RC2-64", rc264cbc_functions),
 119     ALG("RC2-CFB", rc2128cfb128_functions),
 120     ALG("RC2-OFB", rc2128ofb128_functions),
 121 #endif /* OPENSSL_NO_RC2 */
 122 #ifndef OPENSSL_NO_RC4
 123     ALG("RC4", rc4128_functions),
 124     ALG("RC4-40", rc440_functions),
 125 # ifndef OPENSSL_NO_MD5
 126     ALG("RC4-HMAC-MD5", rc4_hmac_md5_functions),
 127 # endif /* OPENSSL_NO_MD5 */
 128 #endif /* OPENSSL_NO_RC4 */
 129 #ifndef OPENSSL_NO_RC5
 130     ALG("RC5-ECB", rc5128ecb_functions),
 131     ALG("RC5-CBC:RC5", rc5128cbc_functions),
 132     ALG("RC5-OFB", rc5128ofb64_functions),
 133     ALG("RC5-CFB", rc5128cfb64_functions),
 134 #endif /* OPENSSL_NO_RC5 */
 135 #ifndef OPENSSL_NO_DES
 136     ALG("DESX-CBC:DESX", tdes_desx_cbc_functions),
 137     ALG("DES-ECB", des_ecb_functions),
 138     ALG("DES-CBC:DES", des_cbc_functions),
 139     ALG("DES-OFB", des_ofb64_functions),
 140     ALG("DES-CFB", des_cfb64_functions),
 141     ALG("DES-CFB1", des_cfb1_functions),
 142     ALG("DES-CFB8", des_cfb8_functions),
 143 #endif /* OPENSSL_NO_DES */
 144     { NULL, NULL, NULL }
 145 };
 146
 147 static const OSSL_ALGORITHM *legacy_query(void *provctx, int operation_id,
 148                                           int *no_cache)
 149 {
 150     *no_cache = 0;
 151     switch (operation_id) {
 152     case OSSL_OP_DIGEST:
 153         return legacy_digests;
 154     case OSSL_OP_CIPHER:
 155         return legacy_ciphers;
 156     }
 157     return NULL;
 158 }
 159
 160 static void legacy_teardown(void *provctx)
 161 {
 162     OPENSSL_CTX_free(PROV_LIBRARY_CONTEXT_OF(provctx));
 163     PROV_CTX_free(provctx);
 164 }
 165
 166 /* Functions we provide to the core */
 167 static const OSSL_DISPATCH legacy_dispatch_table[] = {
 168     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))legacy_teardown },
 169     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))legacy_gettable_params },
 170     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))legacy_get_params },
 171     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))legacy_query },
 172     { 0, NULL }
 173 };
 174
 175 int OSSL_provider_init(const OSSL_CORE_HANDLE *handle,
 176                        const OSSL_DISPATCH *in,
 177                        const OSSL_DISPATCH **out,
 178                        void **provctx)
 179 {
 180     OSSL_FUNC_core_get_library_context_fn *c_get_libctx = NULL;
 181     OPENSSL_CTX *libctx = NULL;
 182
 183     for (; in->function_id != 0; in++) {
 184         switch (in->function_id) {
 185         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
 186             c_gettable_params = OSSL_FUNC_core_gettable_params(in);
 187             break;
 188         case OSSL_FUNC_CORE_GET_PARAMS:
 189             c_get_params = OSSL_FUNC_core_get_params(in);
 190             break;
 191         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
 192             c_get_libctx = OSSL_FUNC_core_get_library_context(in);
 193             break;
 194         /* Just ignore anything we don't understand */
 195         default:
 196             break;
 197         }
 198     }
 199
 200     if (c_get_libctx == NULL)
 201         return 0;
 202
 203     if ((*provctx = PROV_CTX_new()) == NULL
 204         || (libctx = OPENSSL_CTX_new()) == NULL) {
 205         OPENSSL_CTX_free(libctx);
 206         legacy_teardown(*provctx);
 207         *provctx = NULL;
 208         return 0;
 209     }
 210     PROV_CTX_set0_library_context(*provctx, libctx);
 211     PROV_CTX_set0_handle(*provctx, handle);
 212
 213     *out = legacy_dispatch_table;
 214
 215     return 1;
 216 }