Coverage Report

Created: 2025-06-22 06:56

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