Coverage Report

Created: 2026-07-24 06:26

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/crypto/evp/skeymgmt_meth.c
Line
Count
Source
1
/*
2
 * Copyright 2025 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_dispatch.h>
12
#include <openssl/evp.h>
13
#include <openssl/err.h>
14
#include "internal/core.h"
15
#include "internal/provider.h"
16
#include "internal/refcount.h"
17
#include "crypto/evp.h"
18
#include "evp_local.h"
19
20
static void evp_skeymgmt_free(void *s);
21
22
void *evp_skeymgmt_generate(const EVP_SKEYMGMT *skeymgmt, const OSSL_PARAM params[])
23
0
{
24
0
    void *provctx = ossl_provider_ctx(EVP_SKEYMGMT_get0_provider(skeymgmt));
25
26
0
    return (skeymgmt->generate != NULL) ? skeymgmt->generate(provctx, params) : NULL;
27
0
}
28
29
void *evp_skeymgmt_import(const EVP_SKEYMGMT *skeymgmt, int selection, const OSSL_PARAM params[])
30
0
{
31
0
    void *provctx = ossl_provider_ctx(EVP_SKEYMGMT_get0_provider(skeymgmt));
32
33
    /* This is mandatory, no need to check for its presence */
34
0
    return skeymgmt->import(provctx, selection, params);
35
0
}
36
37
int evp_skeymgmt_export(const EVP_SKEYMGMT *skeymgmt, void *keydata,
38
    int selection, OSSL_CALLBACK *param_cb, void *cbarg)
39
0
{
40
    /* This is mandatory, no need to check for its presence */
41
0
    return skeymgmt->export(keydata, selection, param_cb, cbarg);
42
0
}
43
44
void evp_skeymgmt_freedata(const EVP_SKEYMGMT *skeymgmt, void *keydata)
45
0
{
46
    /* This is mandatory, no need to check for its presence */
47
0
    skeymgmt->free(keydata);
48
0
}
49
50
static void *skeymgmt_new(void)
51
0
{
52
0
    EVP_SKEYMGMT *skeymgmt = NULL;
53
54
0
    if ((skeymgmt = OPENSSL_zalloc(sizeof(*skeymgmt))) == NULL)
55
0
        return NULL;
56
0
    if (!CRYPTO_NEW_REF(&skeymgmt->refcnt, 1)) {
57
0
        evp_skeymgmt_free(skeymgmt);
58
0
        return NULL;
59
0
    }
60
0
    return skeymgmt;
61
0
}
62
63
static void *skeymgmt_from_algorithm(int name_id,
64
    const OSSL_ALGORITHM *algodef,
65
    OSSL_PROVIDER *prov, int no_store)
66
0
{
67
0
    const OSSL_DISPATCH *fns = algodef->implementation;
68
0
    EVP_SKEYMGMT *skeymgmt = NULL;
69
70
0
    if ((skeymgmt = skeymgmt_new()) == NULL)
71
0
        return NULL;
72
73
0
    skeymgmt->name_id = name_id;
74
0
    skeymgmt->no_store = no_store;
75
0
    if ((skeymgmt->type_name = ossl_algorithm_get1_first_name(algodef)) == NULL) {
76
0
        evp_skeymgmt_free(skeymgmt);
77
0
        return NULL;
78
0
    }
79
0
    skeymgmt->description = algodef->algorithm_description;
80
81
0
    for (; fns->function_id != 0; fns++) {
82
0
        switch (fns->function_id) {
83
0
        case OSSL_FUNC_SKEYMGMT_FREE:
84
0
            if (skeymgmt->free == NULL)
85
0
                skeymgmt->free = OSSL_FUNC_skeymgmt_free(fns);
86
0
            break;
87
0
        case OSSL_FUNC_SKEYMGMT_IMPORT:
88
0
            if (skeymgmt->import == NULL)
89
0
                skeymgmt->import = OSSL_FUNC_skeymgmt_import(fns);
90
0
            break;
91
0
        case OSSL_FUNC_SKEYMGMT_EXPORT:
92
0
            if (skeymgmt->export == NULL)
93
0
                skeymgmt->export = OSSL_FUNC_skeymgmt_export(fns);
94
0
            break;
95
0
        case OSSL_FUNC_SKEYMGMT_GENERATE:
96
0
            if (skeymgmt->generate == NULL)
97
0
                skeymgmt->generate = OSSL_FUNC_skeymgmt_generate(fns);
98
0
            break;
99
0
        case OSSL_FUNC_SKEYMGMT_GET_KEY_ID:
100
0
            if (skeymgmt->get_key_id == NULL)
101
0
                skeymgmt->get_key_id = OSSL_FUNC_skeymgmt_get_key_id(fns);
102
0
            break;
103
0
        case OSSL_FUNC_SKEYMGMT_IMP_SETTABLE_PARAMS:
104
0
            if (skeymgmt->imp_params == NULL)
105
0
                skeymgmt->imp_params = OSSL_FUNC_skeymgmt_imp_settable_params(fns);
106
0
            break;
107
0
        case OSSL_FUNC_SKEYMGMT_GEN_SETTABLE_PARAMS:
108
0
            if (skeymgmt->gen_params == NULL)
109
0
                skeymgmt->gen_params = OSSL_FUNC_skeymgmt_gen_settable_params(fns);
110
0
            break;
111
0
        }
112
0
    }
113
114
    /* Check that the provider is sensible */
115
0
    if (skeymgmt->free == NULL
116
0
        || skeymgmt->import == NULL
117
0
        || skeymgmt->export == NULL) {
118
0
        evp_skeymgmt_free(skeymgmt);
119
0
        ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
120
0
        return NULL;
121
0
    }
122
123
0
    if (!ossl_provider_up_ref(prov)) {
124
0
        evp_skeymgmt_free(skeymgmt);
125
0
        ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
126
0
        return NULL;
127
0
    }
128
0
    skeymgmt->prov = prov;
129
130
0
    return skeymgmt;
131
0
}
132
133
static int evp_skeymgmt_up_ref(void *s)
134
0
{
135
0
    EVP_SKEYMGMT *skeymgmt = (EVP_SKEYMGMT *)s;
136
0
    int ref = 0;
137
138
0
    return CRYPTO_UP_REF(&skeymgmt->refcnt, &ref);
139
0
}
140
141
static void evp_skeymgmt_free(void *s)
142
0
{
143
0
    EVP_SKEYMGMT *skeymgmt = (EVP_SKEYMGMT *)s;
144
0
    int ref = 0;
145
146
0
    if (skeymgmt == NULL)
147
0
        return;
148
149
0
    CRYPTO_DOWN_REF(&skeymgmt->refcnt, &ref);
150
0
    if (ref > 0)
151
0
        return;
152
0
    OPENSSL_free(skeymgmt->type_name);
153
0
    ossl_provider_free(skeymgmt->prov);
154
0
    CRYPTO_FREE_REF(&skeymgmt->refcnt);
155
0
    OPENSSL_free(skeymgmt);
156
0
}
157
158
EVP_SKEYMGMT *evp_skeymgmt_fetch_from_prov(OSSL_PROVIDER *prov,
159
    const char *name,
160
    const char *properties)
161
0
{
162
0
    return evp_generic_fetch_from_prov(prov,
163
0
        OSSL_OP_SKEYMGMT,
164
0
        name, properties,
165
0
        skeymgmt_from_algorithm,
166
0
        evp_skeymgmt_up_ref,
167
0
        evp_skeymgmt_free);
168
0
}
169
170
EVP_SKEYMGMT *EVP_SKEYMGMT_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
171
    const char *properties)
172
0
{
173
0
    return evp_generic_fetch(ctx, OSSL_OP_SKEYMGMT, algorithm, properties,
174
0
        skeymgmt_from_algorithm,
175
0
        evp_skeymgmt_up_ref,
176
0
        evp_skeymgmt_free);
177
0
}
178
179
int EVP_SKEYMGMT_up_ref(EVP_SKEYMGMT *skeymgmt)
180
0
{
181
#ifdef OPENSSL_NO_CACHED_FETCH
182
    return evp_skeymgmt_up_ref(skeymgmt);
183
#else
184
0
    if (skeymgmt->no_store != 0)
185
0
        return evp_skeymgmt_up_ref(skeymgmt);
186
0
    return 1;
187
0
#endif
188
0
}
189
190
void EVP_SKEYMGMT_free(EVP_SKEYMGMT *skeymgmt)
191
0
{
192
#ifdef OPENSSL_NO_CACHED_FETCH
193
    evp_skeymgmt_free(skeymgmt);
194
#else
195
0
    if (skeymgmt != NULL && (skeymgmt->no_store != 0))
196
0
        evp_skeymgmt_free(skeymgmt);
197
0
#endif
198
0
}
199
200
const OSSL_PROVIDER *EVP_SKEYMGMT_get0_provider(const EVP_SKEYMGMT *skeymgmt)
201
0
{
202
0
    return (skeymgmt != NULL) ? skeymgmt->prov : NULL;
203
0
}
204
205
const char *EVP_SKEYMGMT_get0_description(const EVP_SKEYMGMT *skeymgmt)
206
0
{
207
0
    return (skeymgmt != NULL) ? skeymgmt->description : NULL;
208
0
}
209
210
const char *EVP_SKEYMGMT_get0_name(const EVP_SKEYMGMT *skeymgmt)
211
0
{
212
0
    return (skeymgmt != NULL) ? skeymgmt->type_name : NULL;
213
0
}
214
215
int EVP_SKEYMGMT_is_a(const EVP_SKEYMGMT *skeymgmt, const char *name)
216
0
{
217
0
    return skeymgmt != NULL
218
0
        && evp_is_a(skeymgmt->prov, skeymgmt->name_id, NULL, name);
219
0
}
220
221
void EVP_SKEYMGMT_do_all_provided(OSSL_LIB_CTX *libctx,
222
    void (*fn)(EVP_SKEYMGMT *skeymgmt, void *arg),
223
    void *arg)
224
0
{
225
0
    struct EVP_SKEYMGMT_do_all_provided_thunk t;
226
227
0
    t.fn = fn;
228
0
    t.arg = arg;
229
0
    evp_generic_do_all(libctx, OSSL_OP_SKEYMGMT,
230
0
        EVP_SKEYMGMT_do_all_provided_thunk, &t,
231
0
        skeymgmt_from_algorithm,
232
0
        evp_skeymgmt_up_ref,
233
0
        evp_skeymgmt_free);
234
0
}
235
236
int EVP_SKEYMGMT_names_do_all(const EVP_SKEYMGMT *skeymgmt,
237
    void (*fn)(const char *name, void *data),
238
    void *data)
239
0
{
240
0
    if (skeymgmt == NULL)
241
0
        return 0;
242
243
0
    if (skeymgmt->prov != NULL)
244
0
        return evp_names_do_all(skeymgmt->prov, skeymgmt->name_id, fn, data);
245
246
0
    return 1;
247
0
}
248
249
const OSSL_PARAM *EVP_SKEYMGMT_get0_gen_settable_params(const EVP_SKEYMGMT *skeymgmt)
250
0
{
251
0
    void *provctx = NULL;
252
253
0
    if (skeymgmt == NULL)
254
0
        return 0;
255
256
0
    provctx = ossl_provider_ctx(EVP_SKEYMGMT_get0_provider(skeymgmt));
257
258
0
    return (skeymgmt->gen_params != NULL) ? skeymgmt->gen_params(provctx) : NULL;
259
0
}
260
261
const OSSL_PARAM *EVP_SKEYMGMT_get0_imp_settable_params(const EVP_SKEYMGMT *skeymgmt)
262
0
{
263
0
    void *provctx = NULL;
264
265
0
    if (skeymgmt == NULL)
266
0
        return 0;
267
268
0
    provctx = ossl_provider_ctx(EVP_SKEYMGMT_get0_provider(skeymgmt));
269
270
0
    return (skeymgmt->imp_params != NULL) ? skeymgmt->imp_params(provctx) : NULL;
271
0
}