1 /*
2 * Copyright 2019-2026 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
4 *
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
9 */
10
11 #include <string.h>
12 #include <openssl/err.h>
13 #include <openssl/cryptoerr.h>
14 #include <openssl/params.h>
15 #include <openssl/types.h>
16 #include <openssl/safestack.h>
17 #include "internal/param_build_set.h"
18
19 /*
20 * Special internal param type to indicate the end of an allocate OSSL_PARAM
21 * array.
22 */
23
24 typedef struct {
25 const char *key;
26 int type;
27 int secure;
28 size_t size;
29 size_t alloc_blocks;
30 const BIGNUM *bn;
31 const void *string;
32 union {
33 /*
34 * These fields are never directly addressed, but their sizes are
35 * important so that all native types can be copied here without overrun.
36 */
37 ossl_intmax_t i;
38 ossl_uintmax_t u;
39 double d;
40 } num;
41 } OSSL_PARAM_BLD_DEF;
42
43 DEFINE_STACK_OF(OSSL_PARAM_BLD_DEF)
44
45 struct ossl_param_bld_st {
46 size_t total_blocks;
47 size_t secure_blocks;
48 STACK_OF(OSSL_PARAM_BLD_DEF) *params;
49 };
50
param_push(OSSL_PARAM_BLD * bld,const char * key,size_t size,size_t alloc,int type,int secure)51 static OSSL_PARAM_BLD_DEF *param_push(OSSL_PARAM_BLD *bld, const char *key,
52 size_t size, size_t alloc, int type,
53 int secure)
54 {
55 OSSL_PARAM_BLD_DEF *pd = OPENSSL_zalloc(sizeof(*pd));
56
57 if (pd == NULL)
58 return NULL;
59 pd->key = key;
60 pd->type = type;
61 pd->size = size;
62 pd->alloc_blocks = ossl_param_bytes_to_blocks(alloc);
63 if ((pd->secure = secure) != 0)
64 bld->secure_blocks += pd->alloc_blocks;
65 else
66 bld->total_blocks += pd->alloc_blocks;
67 if (sk_OSSL_PARAM_BLD_DEF_push(bld->params, pd) <= 0) {
68 OPENSSL_free(pd);
69 pd = NULL;
70 }
71 return pd;
72 }
73
param_push_num(OSSL_PARAM_BLD * bld,const char * key,void * num,size_t size,int type)74 static int param_push_num(OSSL_PARAM_BLD *bld, const char *key,
75 void *num, size_t size, int type)
76 {
77 OSSL_PARAM_BLD_DEF *pd = param_push(bld, key, size, size, type, 0);
78
79 if (pd == NULL) {
80 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
81 return 0;
82 }
83 if (size > sizeof(pd->num)) {
84 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_MANY_BYTES);
85 return 0;
86 }
87 memcpy(&pd->num, num, size);
88 return 1;
89 }
90
OSSL_PARAM_BLD_new(void)91 OSSL_PARAM_BLD *OSSL_PARAM_BLD_new(void)
92 {
93 OSSL_PARAM_BLD *r = OPENSSL_zalloc(sizeof(OSSL_PARAM_BLD));
94
95 if (r != NULL) {
96 r->params = sk_OSSL_PARAM_BLD_DEF_new_null();
97 if (r->params == NULL) {
98 OPENSSL_free(r);
99 r = NULL;
100 }
101 }
102 return r;
103 }
104
free_all_params(OSSL_PARAM_BLD * bld)105 static void free_all_params(OSSL_PARAM_BLD *bld)
106 {
107 int i, n = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
108
109 for (i = 0; i < n; i++)
110 OPENSSL_free(sk_OSSL_PARAM_BLD_DEF_pop(bld->params));
111 }
112
OSSL_PARAM_BLD_free(OSSL_PARAM_BLD * bld)113 void OSSL_PARAM_BLD_free(OSSL_PARAM_BLD *bld)
114 {
115 if (bld == NULL)
116 return;
117 free_all_params(bld);
118 sk_OSSL_PARAM_BLD_DEF_free(bld->params);
119 OPENSSL_free(bld);
120 }
121
OSSL_PARAM_BLD_push_int(OSSL_PARAM_BLD * bld,const char * key,int num)122 int OSSL_PARAM_BLD_push_int(OSSL_PARAM_BLD *bld, const char *key, int num)
123 {
124 if (bld == NULL || key == NULL) {
125 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
126 return 0;
127 }
128
129 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
130 }
131
OSSL_PARAM_BLD_push_uint(OSSL_PARAM_BLD * bld,const char * key,unsigned int num)132 int OSSL_PARAM_BLD_push_uint(OSSL_PARAM_BLD *bld, const char *key,
133 unsigned int num)
134 {
135 if (bld == NULL || key == NULL) {
136 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
137 return 0;
138 }
139
140 return param_push_num(bld, key, &num, sizeof(num),
141 OSSL_PARAM_UNSIGNED_INTEGER);
142 }
143
OSSL_PARAM_BLD_push_long(OSSL_PARAM_BLD * bld,const char * key,long int num)144 int OSSL_PARAM_BLD_push_long(OSSL_PARAM_BLD *bld, const char *key,
145 long int num)
146 {
147 if (bld == NULL || key == NULL) {
148 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
149 return 0;
150 }
151
152 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
153 }
154
OSSL_PARAM_BLD_push_ulong(OSSL_PARAM_BLD * bld,const char * key,unsigned long int num)155 int OSSL_PARAM_BLD_push_ulong(OSSL_PARAM_BLD *bld, const char *key,
156 unsigned long int num)
157 {
158 if (bld == NULL || key == NULL) {
159 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
160 return 0;
161 }
162
163 return param_push_num(bld, key, &num, sizeof(num),
164 OSSL_PARAM_UNSIGNED_INTEGER);
165 }
166
OSSL_PARAM_BLD_push_int32(OSSL_PARAM_BLD * bld,const char * key,int32_t num)167 int OSSL_PARAM_BLD_push_int32(OSSL_PARAM_BLD *bld, const char *key,
168 int32_t num)
169 {
170 if (bld == NULL || key == NULL) {
171 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
172 return 0;
173 }
174
175 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
176 }
177
OSSL_PARAM_BLD_push_uint32(OSSL_PARAM_BLD * bld,const char * key,uint32_t num)178 int OSSL_PARAM_BLD_push_uint32(OSSL_PARAM_BLD *bld, const char *key,
179 uint32_t num)
180 {
181 if (bld == NULL || key == NULL) {
182 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
183 return 0;
184 }
185
186 return param_push_num(bld, key, &num, sizeof(num),
187 OSSL_PARAM_UNSIGNED_INTEGER);
188 }
189
OSSL_PARAM_BLD_push_int64(OSSL_PARAM_BLD * bld,const char * key,int64_t num)190 int OSSL_PARAM_BLD_push_int64(OSSL_PARAM_BLD *bld, const char *key,
191 int64_t num)
192 {
193 if (bld == NULL || key == NULL) {
194 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
195 return 0;
196 }
197
198 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
199 }
200
OSSL_PARAM_BLD_push_uint64(OSSL_PARAM_BLD * bld,const char * key,uint64_t num)201 int OSSL_PARAM_BLD_push_uint64(OSSL_PARAM_BLD *bld, const char *key,
202 uint64_t num)
203 {
204 if (bld == NULL || key == NULL) {
205 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
206 return 0;
207 }
208
209 return param_push_num(bld, key, &num, sizeof(num),
210 OSSL_PARAM_UNSIGNED_INTEGER);
211 }
212
OSSL_PARAM_BLD_push_size_t(OSSL_PARAM_BLD * bld,const char * key,size_t num)213 int OSSL_PARAM_BLD_push_size_t(OSSL_PARAM_BLD *bld, const char *key,
214 size_t num)
215 {
216 if (bld == NULL || key == NULL) {
217 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
218 return 0;
219 }
220
221 return param_push_num(bld, key, &num, sizeof(num),
222 OSSL_PARAM_UNSIGNED_INTEGER);
223 }
224
OSSL_PARAM_BLD_push_time_t(OSSL_PARAM_BLD * bld,const char * key,time_t num)225 int OSSL_PARAM_BLD_push_time_t(OSSL_PARAM_BLD *bld, const char *key,
226 time_t num)
227 {
228 if (bld == NULL || key == NULL) {
229 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
230 return 0;
231 }
232
233 return param_push_num(bld, key, &num, sizeof(num),
234 OSSL_PARAM_INTEGER);
235 }
236
OSSL_PARAM_BLD_push_double(OSSL_PARAM_BLD * bld,const char * key,double num)237 int OSSL_PARAM_BLD_push_double(OSSL_PARAM_BLD *bld, const char *key,
238 double num)
239 {
240 if (bld == NULL || key == NULL) {
241 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
242 return 0;
243 }
244
245 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_REAL);
246 }
247
push_BN(OSSL_PARAM_BLD * bld,const char * key,const BIGNUM * bn,size_t sz,int type)248 static int push_BN(OSSL_PARAM_BLD *bld, const char *key,
249 const BIGNUM *bn, size_t sz, int type)
250 {
251 int n, secure = 0;
252 OSSL_PARAM_BLD_DEF *pd;
253
254 if (bld == NULL || key == NULL) {
255 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
256 return 0;
257 }
258
259 if (!ossl_assert(type == OSSL_PARAM_UNSIGNED_INTEGER
260 || type == OSSL_PARAM_INTEGER))
261 return 0;
262
263 if (bn != NULL) {
264 if (type == OSSL_PARAM_UNSIGNED_INTEGER && BN_is_negative(bn)) {
265 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_UNSUPPORTED,
266 "Negative big numbers are unsupported for OSSL_PARAM_UNSIGNED_INTEGER");
267 return 0;
268 }
269
270 n = BN_num_bytes(bn);
271 if (n < 0) {
272 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_ZERO_LENGTH_NUMBER);
273 return 0;
274 }
275 if (sz < (size_t)n) {
276 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_SMALL_BUFFER);
277 return 0;
278 }
279 if (BN_get_flags(bn, BN_FLG_SECURE) == BN_FLG_SECURE)
280 secure = 1;
281
282 /* The BIGNUM is zero, we must transfer at least one byte */
283 if (sz == 0)
284 sz++;
285 }
286 pd = param_push(bld, key, sz, sz, type, secure);
287 if (pd == NULL)
288 return 0;
289 pd->bn = bn;
290 return 1;
291 }
292
OSSL_PARAM_BLD_push_BN(OSSL_PARAM_BLD * bld,const char * key,const BIGNUM * bn)293 int OSSL_PARAM_BLD_push_BN(OSSL_PARAM_BLD *bld, const char *key,
294 const BIGNUM *bn)
295 {
296 if (bld == NULL || key == NULL) {
297 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
298 return 0;
299 }
300
301 if (bn != NULL && BN_is_negative(bn))
302 return push_BN(bld, key, bn, BN_num_bytes(bn) + 1,
303 OSSL_PARAM_INTEGER);
304 return push_BN(bld, key, bn, bn == NULL ? 0 : BN_num_bytes(bn),
305 OSSL_PARAM_UNSIGNED_INTEGER);
306 }
307
OSSL_PARAM_BLD_push_BN_pad(OSSL_PARAM_BLD * bld,const char * key,const BIGNUM * bn,size_t sz)308 int OSSL_PARAM_BLD_push_BN_pad(OSSL_PARAM_BLD *bld, const char *key,
309 const BIGNUM *bn, size_t sz)
310 {
311 if (bld == NULL || key == NULL) {
312 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
313 return 0;
314 }
315
316 if (bn != NULL && BN_is_negative(bn))
317 return push_BN(bld, key, bn, BN_num_bytes(bn),
318 OSSL_PARAM_INTEGER);
319 return push_BN(bld, key, bn, sz, OSSL_PARAM_UNSIGNED_INTEGER);
320 }
321
OSSL_PARAM_BLD_push_utf8_string(OSSL_PARAM_BLD * bld,const char * key,const char * buf,size_t bsize)322 int OSSL_PARAM_BLD_push_utf8_string(OSSL_PARAM_BLD *bld, const char *key,
323 const char *buf, size_t bsize)
324 {
325 OSSL_PARAM_BLD_DEF *pd;
326 int secure;
327
328 if (bld == NULL || key == NULL || buf == NULL) {
329 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
330 return 0;
331 }
332
333 if (bsize == 0)
334 bsize = strlen(buf);
335 secure = CRYPTO_secure_allocated(buf);
336 pd = param_push(bld, key, bsize, bsize + 1, OSSL_PARAM_UTF8_STRING, secure);
337 if (pd == NULL)
338 return 0;
339 pd->string = buf;
340 return 1;
341 }
342
OSSL_PARAM_BLD_push_utf8_ptr(OSSL_PARAM_BLD * bld,const char * key,char * buf,size_t bsize)343 int OSSL_PARAM_BLD_push_utf8_ptr(OSSL_PARAM_BLD *bld, const char *key,
344 char *buf, size_t bsize)
345 {
346 OSSL_PARAM_BLD_DEF *pd;
347
348 if (bld == NULL || key == NULL) {
349 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
350 return 0;
351 }
352
353 if (bsize == 0)
354 bsize = strlen(buf);
355 pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_UTF8_PTR, 0);
356 if (pd == NULL)
357 return 0;
358 pd->string = buf;
359 return 1;
360 }
361
OSSL_PARAM_BLD_push_octet_string(OSSL_PARAM_BLD * bld,const char * key,const void * buf,size_t bsize)362 int OSSL_PARAM_BLD_push_octet_string(OSSL_PARAM_BLD *bld, const char *key,
363 const void *buf, size_t bsize)
364 {
365 OSSL_PARAM_BLD_DEF *pd;
366 int secure;
367
368 if (bld == NULL || key == NULL || buf == NULL) {
369 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
370 return 0;
371 }
372
373 secure = CRYPTO_secure_allocated(buf);
374 pd = param_push(bld, key, bsize, bsize, OSSL_PARAM_OCTET_STRING, secure);
375 if (pd == NULL)
376 return 0;
377 pd->string = buf;
378 return 1;
379 }
380
OSSL_PARAM_BLD_push_octet_ptr(OSSL_PARAM_BLD * bld,const char * key,void * buf,size_t bsize)381 int OSSL_PARAM_BLD_push_octet_ptr(OSSL_PARAM_BLD *bld, const char *key,
382 void *buf, size_t bsize)
383 {
384 OSSL_PARAM_BLD_DEF *pd;
385
386 if (bld == NULL || key == NULL) {
387 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
388 return 0;
389 }
390
391 pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_OCTET_PTR, 0);
392 if (pd == NULL)
393 return 0;
394 pd->string = buf;
395 return 1;
396 }
397
param_bld_convert(OSSL_PARAM_BLD * bld,OSSL_PARAM * param,OSSL_PARAM_ALIGNED_BLOCK * blk,OSSL_PARAM_ALIGNED_BLOCK * secure)398 static OSSL_PARAM *param_bld_convert(OSSL_PARAM_BLD *bld, OSSL_PARAM *param,
399 OSSL_PARAM_ALIGNED_BLOCK *blk,
400 OSSL_PARAM_ALIGNED_BLOCK *secure)
401 {
402 int i, num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
403 OSSL_PARAM_BLD_DEF *pd;
404 void *p;
405
406 for (i = 0; i < num; i++) {
407 pd = sk_OSSL_PARAM_BLD_DEF_value(bld->params, i);
408 param[i].key = pd->key;
409 param[i].data_type = pd->type;
410 param[i].data_size = pd->size;
411 param[i].return_size = OSSL_PARAM_UNMODIFIED;
412
413 if (pd->secure) {
414 p = secure;
415 secure += pd->alloc_blocks;
416 } else {
417 p = blk;
418 blk += pd->alloc_blocks;
419 }
420 param[i].data = p;
421 if (pd->bn != NULL) {
422 /* BIGNUM */
423 if (pd->type == OSSL_PARAM_UNSIGNED_INTEGER)
424 BN_bn2nativepad(pd->bn, (unsigned char *)p, pd->size);
425 else
426 BN_signed_bn2native(pd->bn, (unsigned char *)p, pd->size);
427 } else if (pd->type == OSSL_PARAM_OCTET_PTR
428 || pd->type == OSSL_PARAM_UTF8_PTR) {
429 /* PTR */
430 *(const void **)p = pd->string;
431 } else if (pd->type == OSSL_PARAM_OCTET_STRING
432 || pd->type == OSSL_PARAM_UTF8_STRING) {
433 if (pd->string != NULL)
434 memcpy(p, pd->string, pd->size);
435 else
436 memset(p, 0, pd->size);
437 if (pd->type == OSSL_PARAM_UTF8_STRING)
438 ((char *)p)[pd->size] = '\0';
439 } else {
440 /* Number, but could also be a NULL BIGNUM */
441 if (pd->size > sizeof(pd->num))
442 memset(p, 0, pd->size);
443 else if (pd->size > 0)
444 memcpy(p, &pd->num, pd->size);
445 }
446 }
447 param[i] = OSSL_PARAM_construct_end();
448 return param + i;
449 }
450
OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD * bld)451 OSSL_PARAM *OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD *bld)
452 {
453 OSSL_PARAM_ALIGNED_BLOCK *blk, *s = NULL;
454 OSSL_PARAM *params, *last;
455 int num;
456 size_t p_blks, total, ss;
457
458 if (bld == NULL) {
459 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
460 return 0;
461 }
462
463 num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
464 p_blks = ossl_param_bytes_to_blocks((1 + num) * sizeof(*params));
465 total = OSSL_PARAM_ALIGN_SIZE * (p_blks + bld->total_blocks);
466 ss = OSSL_PARAM_ALIGN_SIZE * bld->secure_blocks;
467
468 if (ss > 0) {
469 s = OPENSSL_secure_malloc(ss);
470 if (s == NULL) {
471 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_SECURE_MALLOC_FAILURE);
472 return NULL;
473 }
474 }
475 params = OPENSSL_malloc(total);
476 if (params == NULL) {
477 OPENSSL_secure_free(s);
478 return NULL;
479 }
480 blk = p_blks + (OSSL_PARAM_ALIGNED_BLOCK *)(params);
481 last = param_bld_convert(bld, params, blk, s);
482 ossl_param_set_secure_block(last, s, ss);
483
484 /* Reset builder for reuse */
485 bld->total_blocks = 0;
486 bld->secure_blocks = 0;
487 free_all_params(bld);
488 return params;
489 }
490