Coverage Report

Created: 2025-08-25 06:30

/src/openssl/crypto/params_dup.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2021-2022 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
0
#define OSSL_PARAM_ALLOCATED_END    127
17
0
#define OSSL_PARAM_MERGE_LIST_MAX   128
18
19
0
#define OSSL_PARAM_BUF_PUBLIC 0
20
0
#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
0
{
32
0
    return (bytes + OSSL_PARAM_ALIGN_SIZE - 1) / OSSL_PARAM_ALIGN_SIZE;
33
0
}
34
35
static int ossl_param_buf_alloc(OSSL_PARAM_BUF *out, size_t extra_blocks,
36
                                int is_secure)
37
0
{
38
0
    size_t num_blocks, sz = 0;
39
40
0
    if (ossl_unlikely(!ossl_size_add(extra_blocks, out->blocks, &num_blocks,
41
0
                                     OPENSSL_FILE, OPENSSL_LINE)
42
0
                      || !ossl_size_mul(num_blocks, OSSL_PARAM_ALIGN_SIZE, &sz,
43
0
                                        OPENSSL_FILE, OPENSSL_LINE)))
44
0
        return 0;
45
46
0
    out->alloc = is_secure ? OPENSSL_secure_zalloc(sz) : OPENSSL_zalloc(sz);
47
0
    if (out->alloc == NULL)
48
0
        return 0;
49
0
    out->alloc_sz = sz;
50
0
    out->cur = out->alloc + extra_blocks;
51
0
    return 1;
52
0
}
53
54
void ossl_param_set_secure_block(OSSL_PARAM *last, void *secure_buffer,
55
                                 size_t secure_buffer_sz)
56
0
{
57
0
    last->key = NULL;
58
0
    last->data_size = secure_buffer_sz;
59
0
    last->data = secure_buffer;
60
0
    last->data_type = OSSL_PARAM_ALLOCATED_END;
61
0
}
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
0
{
67
0
    const OSSL_PARAM *in;
68
0
    int has_dst = (dst != NULL);
69
0
    int is_secure;
70
0
    size_t param_sz, blks;
71
72
0
    for (in = src; in->key != NULL; in++) {
73
0
        is_secure = CRYPTO_secure_allocated(in->data);
74
0
        if (has_dst) {
75
0
            *dst = *in;
76
0
            dst->data = buf[is_secure].cur;
77
0
        }
78
79
0
        if (in->data_type == OSSL_PARAM_OCTET_PTR
80
0
            || 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
0
        } else {
85
0
            param_sz = in->data_size;
86
0
            if (has_dst)
87
0
                memcpy(dst->data, in->data, param_sz);
88
0
        }
89
0
        if (in->data_type == OSSL_PARAM_UTF8_STRING)
90
0
            param_sz++; /* NULL terminator */
91
0
        blks = ossl_param_bytes_to_blocks(param_sz);
92
93
0
        if (has_dst) {
94
0
            dst++;
95
0
            buf[is_secure].cur += blks;
96
0
        } else {
97
0
            buf[is_secure].blocks += blks;
98
0
        }
99
0
        if (param_count != NULL)
100
0
            ++*param_count;
101
0
    }
102
0
    return dst;
103
0
}
104
105
OSSL_PARAM *OSSL_PARAM_dup(const OSSL_PARAM *src)
106
0
{
107
0
    size_t param_blocks;
108
0
    OSSL_PARAM_BUF buf[OSSL_PARAM_BUF_MAX];
109
0
    OSSL_PARAM *last, *dst;
110
0
    int param_count = 1; /* Include terminator in the count */
111
112
0
    if (src == NULL) {
113
0
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
114
0
        return NULL;
115
0
    }
116
117
0
    memset(buf, 0, sizeof(buf));
118
119
    /* First Pass: get the param_count and block sizes required */
120
0
    (void)ossl_param_dup(src, NULL, buf, &param_count);
121
122
0
    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
0
    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
0
    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
0
    dst = (OSSL_PARAM *)buf[OSSL_PARAM_BUF_PUBLIC].alloc;
138
0
    last = ossl_param_dup(src, dst, buf, NULL);
139
    /* Store the allocated secure memory buffer in the last param block */
140
0
    ossl_param_set_secure_block(last, buf[OSSL_PARAM_BUF_SECURE].alloc,
141
0
                                buf[OSSL_PARAM_BUF_SECURE].alloc_sz);
142
0
    return dst;
143
0
}
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
0
{
155
0
    const OSSL_PARAM *list1[OSSL_PARAM_MERGE_LIST_MAX + 1];
156
0
    const OSSL_PARAM *list2[OSSL_PARAM_MERGE_LIST_MAX + 1];
157
0
    const OSSL_PARAM *p = NULL;
158
0
    const OSSL_PARAM **p1cur, **p2cur;
159
0
    OSSL_PARAM *params, *dst;
160
0
    size_t  list1_sz = 0, list2_sz = 0;
161
0
    int diff;
162
163
0
    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
0
    if (p1 != NULL) {
170
0
        for (p = p1; p->key != NULL && list1_sz < OSSL_PARAM_MERGE_LIST_MAX; p++)
171
0
            list1[list1_sz++] = p;
172
0
    }
173
0
    list1[list1_sz] = NULL;
174
175
    /* copy p2 to a list2 */
176
0
    if (p2 != NULL) {
177
0
        for (p = p2; p->key != NULL && list2_sz < OSSL_PARAM_MERGE_LIST_MAX; p++)
178
0
            list2[list2_sz++] = p;
179
0
    }
180
0
    list2[list2_sz] = NULL;
181
0
    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
0
    qsort(list1, list1_sz, sizeof(OSSL_PARAM *), compare_params);
188
0
    qsort(list2, list2_sz, sizeof(OSSL_PARAM *), compare_params);
189
190
   /* Allocate enough space to store the merged parameters */
191
0
    params = OPENSSL_calloc(list1_sz + list2_sz + 1, sizeof(*p1));
192
0
    if (params == NULL)
193
0
        return NULL;
194
0
    dst = params;
195
0
    p1cur = list1;
196
0
    p2cur = list2;
197
0
    while (1) {
198
        /* If list1 is finished just tack list2 onto the end */
199
0
        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
0
        if (*p2cur == NULL) {
208
0
            while (*p1cur != NULL) {
209
0
                *dst++ = **p1cur;
210
0
                p1cur++;
211
0
            }
212
0
            break;
213
0
        }
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
0
    return params;
230
0
}
231
232
void OSSL_PARAM_free(OSSL_PARAM *params)
233
0
{
234
0
    if (params != NULL) {
235
0
        OSSL_PARAM *p;
236
237
0
        for (p = params; p->key != NULL; p++)
238
0
            ;
239
0
        if (p->data_type == OSSL_PARAM_ALLOCATED_END)
240
0
            OPENSSL_secure_clear_free(p->data, p->data_size);
241
0
        OPENSSL_free(params);
242
0
    }
243
0
}