Coverage Report

Created: 2026-02-14 07:20

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/crypto/params_dup.c
Line
Count
Source
1
/*
2
 * Copyright 2021-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 <string.h>
11
#include <openssl/params.h>
12
#include <openssl/param_build.h>
13
#include "internal/mem_alloc_utils.h"
14
#include "internal/param_build_set.h"
15
16
695k
#define OSSL_PARAM_ALLOCATED_END 127
17
2.96k
#define OSSL_PARAM_MERGE_LIST_MAX 128
18
19
742
#define OSSL_PARAM_BUF_PUBLIC 0
20
1.11k
#define OSSL_PARAM_BUF_SECURE 1
21
#define OSSL_PARAM_BUF_MAX (OSSL_PARAM_BUF_SECURE + 1)
22
23
typedef struct {
24
    OSSL_PARAM_ALIGNED_BLOCK *alloc; /* The allocated buffer */
25
    OSSL_PARAM_ALIGNED_BLOCK *cur; /* Current position in the allocated buf */
26
    size_t blocks; /* Number of aligned blocks */
27
    size_t alloc_sz; /* The size of the allocated buffer (in bytes) */
28
} OSSL_PARAM_BUF;
29
30
size_t ossl_param_bytes_to_blocks(size_t bytes)
31
2.51M
{
32
2.51M
    return (bytes + OSSL_PARAM_ALIGN_SIZE - 1) / OSSL_PARAM_ALIGN_SIZE;
33
2.51M
}
34
35
static int ossl_param_buf_alloc(OSSL_PARAM_BUF *out, size_t extra_blocks,
36
    int is_secure)
37
244
{
38
244
    size_t num_blocks, sz = 0;
39
40
244
    if (ossl_unlikely(!ossl_size_add(extra_blocks, out->blocks, &num_blocks,
41
244
                          OPENSSL_FILE, OPENSSL_LINE)
42
244
            || !ossl_size_mul(num_blocks, OSSL_PARAM_ALIGN_SIZE, &sz,
43
244
                OPENSSL_FILE, OPENSSL_LINE)))
44
0
        return 0;
45
46
244
    out->alloc = is_secure ? OPENSSL_secure_zalloc(sz) : OPENSSL_zalloc(sz);
47
244
    if (out->alloc == NULL)
48
0
        return 0;
49
244
    out->alloc_sz = sz;
50
244
    out->cur = out->alloc + extra_blocks;
51
244
    return 1;
52
244
}
53
54
void ossl_param_set_secure_block(OSSL_PARAM *last, void *secure_buffer,
55
    size_t secure_buffer_sz)
56
367k
{
57
367k
    last->key = NULL;
58
367k
    last->data_size = secure_buffer_sz;
59
367k
    last->data = secure_buffer;
60
367k
    last->data_type = OSSL_PARAM_ALLOCATED_END;
61
367k
}
62
63
static OSSL_PARAM *ossl_param_dup(const OSSL_PARAM *src, OSSL_PARAM *dst,
64
    OSSL_PARAM_BUF buf[OSSL_PARAM_BUF_MAX],
65
    int *param_count)
66
742
{
67
742
    const OSSL_PARAM *in;
68
742
    int has_dst = (dst != NULL);
69
742
    int is_secure;
70
742
    size_t param_sz, blks;
71
72
2.28k
    for (in = src; in->key != NULL; in++) {
73
1.53k
        is_secure = CRYPTO_secure_allocated(in->data);
74
1.53k
        if (has_dst) {
75
769
            *dst = *in;
76
769
            dst->data = buf[is_secure].cur;
77
769
        }
78
79
1.53k
        if (in->data_type == OSSL_PARAM_OCTET_PTR
80
1.53k
            || in->data_type == OSSL_PARAM_UTF8_PTR) {
81
0
            param_sz = sizeof(in->data);
82
0
            if (has_dst)
83
0
                *((const void **)dst->data) = *(const void **)in->data;
84
1.53k
        } else {
85
1.53k
            param_sz = in->data_size;
86
1.53k
            if (has_dst)
87
769
                memcpy(dst->data, in->data, param_sz);
88
1.53k
        }
89
1.53k
        if (in->data_type == OSSL_PARAM_UTF8_STRING)
90
0
            param_sz++; /* NULL terminator */
91
1.53k
        blks = ossl_param_bytes_to_blocks(param_sz);
92
93
1.53k
        if (has_dst) {
94
769
            dst++;
95
769
            buf[is_secure].cur += blks;
96
769
        } else {
97
769
            buf[is_secure].blocks += blks;
98
769
        }
99
1.53k
        if (param_count != NULL)
100
769
            ++*param_count;
101
1.53k
    }
102
742
    return dst;
103
742
}
104
105
OSSL_PARAM *OSSL_PARAM_dup(const OSSL_PARAM *src)
106
371
{
107
371
    size_t param_blocks;
108
371
    OSSL_PARAM_BUF buf[OSSL_PARAM_BUF_MAX];
109
371
    OSSL_PARAM *last, *dst;
110
371
    int param_count = 1; /* Include terminator in the count */
111
112
371
    if (src == NULL) {
113
0
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
114
0
        return NULL;
115
0
    }
116
117
371
    memset(buf, 0, sizeof(buf));
118
119
    /* First Pass: get the param_count and block sizes required */
120
371
    (void)ossl_param_dup(src, NULL, buf, &param_count);
121
122
371
    param_blocks = ossl_param_bytes_to_blocks(param_count * sizeof(*src));
123
    /*
124
     * The allocated buffer consists of an array of OSSL_PARAM followed by
125
     * aligned data bytes that the array elements will point to.
126
     */
127
371
    if (!ossl_param_buf_alloc(&buf[OSSL_PARAM_BUF_PUBLIC], param_blocks, 0))
128
0
        return NULL;
129
130
    /* Allocate a secure memory buffer if required */
131
371
    if (buf[OSSL_PARAM_BUF_SECURE].blocks > 0
132
0
        && !ossl_param_buf_alloc(&buf[OSSL_PARAM_BUF_SECURE], 0, 1)) {
133
0
        OPENSSL_free(buf[OSSL_PARAM_BUF_PUBLIC].alloc);
134
0
        return NULL;
135
0
    }
136
137
371
    dst = (OSSL_PARAM *)buf[OSSL_PARAM_BUF_PUBLIC].alloc;
138
371
    last = ossl_param_dup(src, dst, buf, NULL);
139
    /* Store the allocated secure memory buffer in the last param block */
140
371
    ossl_param_set_secure_block(last, buf[OSSL_PARAM_BUF_SECURE].alloc,
141
371
        buf[OSSL_PARAM_BUF_SECURE].alloc_sz);
142
371
    return dst;
143
371
}
144
145
static int compare_params(const void *left, const void *right)
146
0
{
147
0
    const OSSL_PARAM *l = *(const OSSL_PARAM **)left;
148
0
    const OSSL_PARAM *r = *(const OSSL_PARAM **)right;
149
150
0
    return OPENSSL_strcasecmp(l->key, r->key);
151
0
}
152
153
OSSL_PARAM *OSSL_PARAM_merge(const OSSL_PARAM *p1, const OSSL_PARAM *p2)
154
2.96k
{
155
2.96k
    const OSSL_PARAM *list1[OSSL_PARAM_MERGE_LIST_MAX + 1];
156
2.96k
    const OSSL_PARAM *list2[OSSL_PARAM_MERGE_LIST_MAX + 1];
157
2.96k
    const OSSL_PARAM *p = NULL;
158
2.96k
    const OSSL_PARAM **p1cur, **p2cur;
159
2.96k
    OSSL_PARAM *params, *dst;
160
2.96k
    size_t list1_sz = 0, list2_sz = 0;
161
2.96k
    int diff;
162
163
2.96k
    if (p1 == NULL && p2 == NULL) {
164
0
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
165
0
        return NULL;
166
0
    }
167
168
    /* Copy p1 to list1 */
169
2.96k
    if (p1 != NULL) {
170
5.92k
        for (p = p1; p->key != NULL && list1_sz < OSSL_PARAM_MERGE_LIST_MAX; p++)
171
2.96k
            list1[list1_sz++] = p;
172
2.96k
    }
173
2.96k
    list1[list1_sz] = NULL;
174
175
    /* copy p2 to a list2 */
176
2.96k
    if (p2 != NULL) {
177
2.96k
        for (p = p2; p->key != NULL && list2_sz < OSSL_PARAM_MERGE_LIST_MAX; p++)
178
0
            list2[list2_sz++] = p;
179
2.96k
    }
180
2.96k
    list2[list2_sz] = NULL;
181
2.96k
    if (list1_sz == 0 && list2_sz == 0) {
182
0
        ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_NO_PARAMS_TO_MERGE);
183
0
        return NULL;
184
0
    }
185
186
    /* Sort the 2 lists */
187
2.96k
    qsort(list1, list1_sz, sizeof(OSSL_PARAM *), compare_params);
188
2.96k
    qsort(list2, list2_sz, sizeof(OSSL_PARAM *), compare_params);
189
190
    /* Allocate enough space to store the merged parameters */
191
2.96k
    params = OPENSSL_calloc(list1_sz + list2_sz + 1, sizeof(*p1));
192
2.96k
    if (params == NULL)
193
0
        return NULL;
194
2.96k
    dst = params;
195
2.96k
    p1cur = list1;
196
2.96k
    p2cur = list2;
197
2.96k
    while (1) {
198
        /* If list1 is finished just tack list2 onto the end */
199
2.96k
        if (*p1cur == NULL) {
200
0
            while (*p2cur != NULL) {
201
0
                *dst++ = **p2cur;
202
0
                p2cur++;
203
0
            }
204
0
            break;
205
0
        }
206
        /* If list2 is finished just tack list1 onto the end */
207
2.96k
        if (*p2cur == NULL) {
208
5.92k
            while (*p1cur != NULL) {
209
2.96k
                *dst++ = **p1cur;
210
2.96k
                p1cur++;
211
2.96k
            }
212
2.96k
            break;
213
2.96k
        }
214
        /* consume the list element with the smaller key */
215
0
        diff = OPENSSL_strcasecmp((*p1cur)->key, (*p2cur)->key);
216
0
        if (diff == 0) {
217
            /* If the keys are the same then throw away the list1 element */
218
0
            *dst++ = **p2cur;
219
0
            p2cur++;
220
0
            p1cur++;
221
0
        } else if (diff > 0) {
222
0
            *dst++ = **p2cur;
223
0
            p2cur++;
224
0
        } else {
225
0
            *dst++ = **p1cur;
226
0
            p1cur++;
227
0
        }
228
0
    }
229
2.96k
    return params;
230
2.96k
}
231
232
void OSSL_PARAM_free(OSSL_PARAM *params)
233
327k
{
234
327k
    if (params != NULL) {
235
327k
        OSSL_PARAM *p;
236
237
2.28M
        for (p = params; p->key != NULL; p++)
238
1.96M
            ;
239
327k
        if (p->data_type == OSSL_PARAM_ALLOCATED_END)
240
315k
            OPENSSL_secure_clear_free(p->data, p->data_size);
241
327k
        OPENSSL_free(params);
242
327k
    }
243
327k
}