providers/implementations/signature/mac_legacy.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 /* We need to use some engine deprecated APIs */
  11 #define OPENSSL_SUPPRESS_DEPRECATED
  12
  13 #include <openssl/crypto.h>
  14 #include <openssl/evp.h>
  15 #include <openssl/core_dispatch.h>
  16 #include <openssl/core_names.h>
  17 #include <openssl/params.h>
  18 #include <openssl/err.h>
  19 #include "prov/implementations.h"
  20 #include "prov/provider_ctx.h"
  21 #include "prov/macsignature.h"
  22 #include "prov/providercommon.h"
  23
  24 static OSSL_FUNC_signature_newctx_fn mac_hmac_newctx;
  25 static OSSL_FUNC_signature_newctx_fn mac_siphash_newctx;
  26 static OSSL_FUNC_signature_newctx_fn mac_poly1305_newctx;
  27 static OSSL_FUNC_signature_newctx_fn mac_cmac_newctx;
  28 static OSSL_FUNC_signature_digest_sign_init_fn mac_digest_sign_init;
  29 static OSSL_FUNC_signature_digest_sign_update_fn mac_digest_sign_update;
  30 static OSSL_FUNC_signature_digest_sign_final_fn mac_digest_sign_final;
  31 static OSSL_FUNC_signature_freectx_fn mac_freectx;
  32 static OSSL_FUNC_signature_dupctx_fn mac_dupctx;
  33 static OSSL_FUNC_signature_set_ctx_params_fn mac_set_ctx_params;
  34 static OSSL_FUNC_signature_settable_ctx_params_fn mac_hmac_settable_ctx_params;
  35 static OSSL_FUNC_signature_settable_ctx_params_fn mac_siphash_settable_ctx_params;
  36 static OSSL_FUNC_signature_settable_ctx_params_fn mac_poly1305_settable_ctx_params;
  37 static OSSL_FUNC_signature_settable_ctx_params_fn mac_cmac_settable_ctx_params;
  38
  39 typedef struct {
  40     OSSL_LIB_CTX *libctx;
  41     char *propq;
  42     MAC_KEY *key;
  43     EVP_MAC_CTX *macctx;
  44 } PROV_MAC_CTX;
  45
  46 static void *mac_newctx(void *provctx, const char *propq, const char *macname)
  47 {
  48     PROV_MAC_CTX *pmacctx;
  49     EVP_MAC *mac = NULL;
  50
  51     if (!ossl_prov_is_running())
  52         return NULL;
  53
  54     pmacctx = OPENSSL_zalloc(sizeof(PROV_MAC_CTX));
  55     if (pmacctx == NULL)
  56         return NULL;
  57
  58     pmacctx->libctx = PROV_LIBCTX_OF(provctx);
  59     if (propq != NULL && (pmacctx->propq = OPENSSL_strdup(propq)) == NULL) {
  60         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  61         goto err;
  62     }
  63
  64     mac = EVP_MAC_fetch(pmacctx->libctx, macname, propq);
  65     if (mac == NULL)
  66         goto err;
  67
  68     pmacctx->macctx = EVP_MAC_CTX_new(mac);
  69     if (pmacctx->macctx == NULL)
  70         goto err;
  71
  72     EVP_MAC_free(mac);
  73
  74     return pmacctx;
  75
  76  err:
  77     OPENSSL_free(pmacctx->propq);
  78     OPENSSL_free(pmacctx);
  79     EVP_MAC_free(mac);
  80     return NULL;
  81 }
  82
  83 #define MAC_NEWCTX(funcname, macname) \
  84     static void *mac_##funcname##_newctx(void *provctx, const char *propq) \
  85     { \
  86         return mac_newctx(provctx, propq, macname); \
  87     }
  88
  89 MAC_NEWCTX(hmac, "HMAC")
  90 MAC_NEWCTX(siphash, "SIPHASH")
  91 MAC_NEWCTX(poly1305, "POLY1305")
  92 MAC_NEWCTX(cmac, "CMAC")
  93
  94 static int mac_digest_sign_init(void *vpmacctx, const char *mdname, void *vkey)
  95 {
  96     PROV_MAC_CTX *pmacctx = (PROV_MAC_CTX *)vpmacctx;
  97     const char *ciphername = NULL, *engine = NULL;
  98
  99     if (!ossl_prov_is_running()
 100             || pmacctx == NULL
 101             || vkey == NULL
 102             || !ossl_mac_key_up_ref(vkey))
 103         return 0;
 104
 105     ossl_mac_key_free(pmacctx->key);
 106     pmacctx->key = vkey;
 107
 108     if (pmacctx->key->cipher.cipher != NULL)
 109         ciphername = (char *)EVP_CIPHER_name(pmacctx->key->cipher.cipher);
 110 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
 111     if (pmacctx->key->cipher.engine != NULL)
 112         engine = (char *)ENGINE_get_id(pmacctx->key->cipher.engine);
 113 #endif
 114
 115     if (!ossl_prov_set_macctx(pmacctx->macctx, NULL,
 116                               (char *)ciphername,
 117                               (char *)mdname,
 118                               (char *)engine,
 119                               pmacctx->key->properties,
 120                               pmacctx->key->priv_key,
 121                               pmacctx->key->priv_key_len))
 122         return 0;
 123
 124     if (!EVP_MAC_init(pmacctx->macctx))
 125         return 0;
 126
 127     return 1;
 128 }
 129
 130 int mac_digest_sign_update(void *vpmacctx, const unsigned char *data,
 131                            size_t datalen)
 132 {
 133     PROV_MAC_CTX *pmacctx = (PROV_MAC_CTX *)vpmacctx;
 134
 135     if (pmacctx == NULL || pmacctx->macctx == NULL)
 136         return 0;
 137
 138     return EVP_MAC_update(pmacctx->macctx, data, datalen);
 139 }
 140
 141 int mac_digest_sign_final(void *vpmacctx, unsigned char *mac, size_t *maclen,
 142                           size_t macsize)
 143 {
 144     PROV_MAC_CTX *pmacctx = (PROV_MAC_CTX *)vpmacctx;
 145
 146     if (!ossl_prov_is_running() || pmacctx == NULL || pmacctx->macctx == NULL)
 147         return 0;
 148
 149     return EVP_MAC_final(pmacctx->macctx, mac, maclen, macsize);
 150 }
 151
 152 static void mac_freectx(void *vpmacctx)
 153 {
 154     PROV_MAC_CTX *ctx = (PROV_MAC_CTX *)vpmacctx;
 155
 156     OPENSSL_free(ctx->propq);
 157     EVP_MAC_CTX_free(ctx->macctx);
 158     ossl_mac_key_free(ctx->key);
 159     OPENSSL_free(ctx);
 160 }
 161
 162 static void *mac_dupctx(void *vpmacctx)
 163 {
 164     PROV_MAC_CTX *srcctx = (PROV_MAC_CTX *)vpmacctx;
 165     PROV_MAC_CTX *dstctx;
 166
 167     if (!ossl_prov_is_running())
 168         return NULL;
 169
 170     dstctx = OPENSSL_zalloc(sizeof(*srcctx));
 171     if (dstctx == NULL)
 172         return NULL;
 173
 174     *dstctx = *srcctx;
 175     dstctx->key = NULL;
 176     dstctx->macctx = NULL;
 177
 178     if (srcctx->key != NULL && !ossl_mac_key_up_ref(srcctx->key))
 179         goto err;
 180     dstctx->key = srcctx->key;
 181
 182     if (srcctx->macctx != NULL) {
 183         dstctx->macctx = EVP_MAC_CTX_dup(srcctx->macctx);
 184         if (dstctx->macctx == NULL)
 185             goto err;
 186     }
 187
 188     return dstctx;
 189  err:
 190     mac_freectx(dstctx);
 191     return NULL;
 192 }
 193
 194 static int mac_set_ctx_params(void *vpmacctx, const OSSL_PARAM params[])
 195 {
 196     PROV_MAC_CTX *ctx = (PROV_MAC_CTX *)vpmacctx;
 197
 198     return EVP_MAC_CTX_set_params(ctx->macctx, params);
 199 }
 200
 201 static const OSSL_PARAM *mac_settable_ctx_params(void *provctx,
 202                                                  const char *macname)
 203 {
 204     EVP_MAC *mac = EVP_MAC_fetch(PROV_LIBCTX_OF(provctx), macname,
 205                                  NULL);
 206     const OSSL_PARAM *params;
 207
 208     if (mac == NULL)
 209         return NULL;
 210
 211     params = EVP_MAC_settable_ctx_params(mac);
 212     EVP_MAC_free(mac);
 213
 214     return params;
 215 }
 216
 217 #define MAC_SETTABLE_CTX_PARAMS(funcname, macname) \
 218     static const OSSL_PARAM *mac_##funcname##_settable_ctx_params(void *provctx) \
 219     { \
 220         return mac_settable_ctx_params(provctx, macname); \
 221     }
 222
 223 MAC_SETTABLE_CTX_PARAMS(hmac, "HMAC")
 224 MAC_SETTABLE_CTX_PARAMS(siphash, "SIPHASH")
 225 MAC_SETTABLE_CTX_PARAMS(poly1305, "POLY1305")
 226 MAC_SETTABLE_CTX_PARAMS(cmac, "CMAC")
 227
 228 #define MAC_SIGNATURE_FUNCTIONS(funcname) \
 229     const OSSL_DISPATCH ossl_mac_legacy_##funcname##_signature_functions[] = { \
 230         { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))mac_##funcname##_newctx }, \
 231         { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT, \
 232         (void (*)(void))mac_digest_sign_init }, \
 233         { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE, \
 234         (void (*)(void))mac_digest_sign_update }, \
 235         { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL, \
 236         (void (*)(void))mac_digest_sign_final }, \
 237         { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))mac_freectx }, \
 238         { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))mac_dupctx }, \
 239         { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, \
 240           (void (*)(void))mac_set_ctx_params }, \
 241         { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS, \
 242           (void (*)(void))mac_##funcname##_settable_ctx_params }, \
 243         { 0, NULL } \
 244     };
 245
 246 MAC_SIGNATURE_FUNCTIONS(hmac)
 247 MAC_SIGNATURE_FUNCTIONS(siphash)
 248 MAC_SIGNATURE_FUNCTIONS(poly1305)
 249 MAC_SIGNATURE_FUNCTIONS(cmac)