2 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
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
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"
20 * Special internal param type to indicate the end of an allocate OSSL_PARAM
34 * These fields are never directly addressed, but their sizes are
35 * imporant so that all native types can be copied here without overrun.
43 DEFINE_STACK_OF(OSSL_PARAM_BLD_DEF)
45 struct ossl_param_bld_st {
48 STACK_OF(OSSL_PARAM_BLD_DEF) *params;
51 static OSSL_PARAM_BLD_DEF *param_push(OSSL_PARAM_BLD *bld, const char *key,
52 int size, size_t alloc, int type,
55 OSSL_PARAM_BLD_DEF *pd = OPENSSL_zalloc(sizeof(*pd));
58 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
64 pd->alloc_blocks = ossl_param_bytes_to_blocks(alloc);
65 if ((pd->secure = secure) != 0)
66 bld->secure_blocks += pd->alloc_blocks;
68 bld->total_blocks += pd->alloc_blocks;
69 if (sk_OSSL_PARAM_BLD_DEF_push(bld->params, pd) <= 0) {
76 static int param_push_num(OSSL_PARAM_BLD *bld, const char *key,
77 void *num, size_t size, int type)
79 OSSL_PARAM_BLD_DEF *pd = param_push(bld, key, size, size, type, 0);
82 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
85 if (size > sizeof(pd->num)) {
86 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_MANY_BYTES);
89 memcpy(&pd->num, num, size);
93 OSSL_PARAM_BLD *OSSL_PARAM_BLD_new(void)
95 OSSL_PARAM_BLD *r = OPENSSL_zalloc(sizeof(OSSL_PARAM_BLD));
98 r->params = sk_OSSL_PARAM_BLD_DEF_new_null();
99 if (r->params == NULL) {
107 static void free_all_params(OSSL_PARAM_BLD *bld)
109 int i, n = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
111 for (i = 0; i < n; i++)
112 OPENSSL_free(sk_OSSL_PARAM_BLD_DEF_pop(bld->params));
115 void OSSL_PARAM_BLD_free(OSSL_PARAM_BLD *bld)
119 free_all_params(bld);
120 sk_OSSL_PARAM_BLD_DEF_free(bld->params);
124 int OSSL_PARAM_BLD_push_int(OSSL_PARAM_BLD *bld, const char *key, int num)
126 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
129 int OSSL_PARAM_BLD_push_uint(OSSL_PARAM_BLD *bld, const char *key,
132 return param_push_num(bld, key, &num, sizeof(num),
133 OSSL_PARAM_UNSIGNED_INTEGER);
136 int OSSL_PARAM_BLD_push_long(OSSL_PARAM_BLD *bld, const char *key,
139 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
142 int OSSL_PARAM_BLD_push_ulong(OSSL_PARAM_BLD *bld, const char *key,
143 unsigned long int num)
145 return param_push_num(bld, key, &num, sizeof(num),
146 OSSL_PARAM_UNSIGNED_INTEGER);
149 int OSSL_PARAM_BLD_push_int32(OSSL_PARAM_BLD *bld, const char *key,
152 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
155 int OSSL_PARAM_BLD_push_uint32(OSSL_PARAM_BLD *bld, const char *key,
158 return param_push_num(bld, key, &num, sizeof(num),
159 OSSL_PARAM_UNSIGNED_INTEGER);
162 int OSSL_PARAM_BLD_push_int64(OSSL_PARAM_BLD *bld, const char *key,
165 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
168 int OSSL_PARAM_BLD_push_uint64(OSSL_PARAM_BLD *bld, const char *key,
171 return param_push_num(bld, key, &num, sizeof(num),
172 OSSL_PARAM_UNSIGNED_INTEGER);
175 int OSSL_PARAM_BLD_push_size_t(OSSL_PARAM_BLD *bld, const char *key,
178 return param_push_num(bld, key, &num, sizeof(num),
179 OSSL_PARAM_UNSIGNED_INTEGER);
182 int OSSL_PARAM_BLD_push_time_t(OSSL_PARAM_BLD *bld, const char *key,
185 return param_push_num(bld, key, &num, sizeof(num),
189 int OSSL_PARAM_BLD_push_double(OSSL_PARAM_BLD *bld, const char *key,
192 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_REAL);
195 int OSSL_PARAM_BLD_push_BN(OSSL_PARAM_BLD *bld, const char *key,
198 return OSSL_PARAM_BLD_push_BN_pad(bld, key, bn,
199 bn == NULL ? 0 : BN_num_bytes(bn));
202 int OSSL_PARAM_BLD_push_BN_pad(OSSL_PARAM_BLD *bld, const char *key,
203 const BIGNUM *bn, size_t sz)
206 OSSL_PARAM_BLD_DEF *pd;
209 if (BN_is_negative(bn)) {
210 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_UNSUPPORTED,
211 "Negative big numbers are unsupported for OSSL_PARAM");
215 n = BN_num_bytes(bn);
217 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_ZERO_LENGTH_NUMBER);
220 if (sz < (size_t)n) {
221 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_SMALL_BUFFER);
224 if (BN_get_flags(bn, BN_FLG_SECURE) == BN_FLG_SECURE)
227 /* The BIGNUM is zero, we must transfer at least one byte */
231 pd = param_push(bld, key, sz, sz, OSSL_PARAM_UNSIGNED_INTEGER, secure);
238 int OSSL_PARAM_BLD_push_utf8_string(OSSL_PARAM_BLD *bld, const char *key,
239 const char *buf, size_t bsize)
241 OSSL_PARAM_BLD_DEF *pd;
246 if (bsize > INT_MAX) {
247 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
250 secure = CRYPTO_secure_allocated(buf);
251 pd = param_push(bld, key, bsize, bsize + 1, OSSL_PARAM_UTF8_STRING, secure);
258 int OSSL_PARAM_BLD_push_utf8_ptr(OSSL_PARAM_BLD *bld, const char *key,
259 char *buf, size_t bsize)
261 OSSL_PARAM_BLD_DEF *pd;
265 if (bsize > INT_MAX) {
266 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
269 pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_UTF8_PTR, 0);
276 int OSSL_PARAM_BLD_push_octet_string(OSSL_PARAM_BLD *bld, const char *key,
277 const void *buf, size_t bsize)
279 OSSL_PARAM_BLD_DEF *pd;
282 if (bsize > INT_MAX) {
283 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
286 secure = CRYPTO_secure_allocated(buf);
287 pd = param_push(bld, key, bsize, bsize, OSSL_PARAM_OCTET_STRING, secure);
294 int OSSL_PARAM_BLD_push_octet_ptr(OSSL_PARAM_BLD *bld, const char *key,
295 void *buf, size_t bsize)
297 OSSL_PARAM_BLD_DEF *pd;
299 if (bsize > INT_MAX) {
300 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
303 pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_OCTET_PTR, 0);
310 static OSSL_PARAM *param_bld_convert(OSSL_PARAM_BLD *bld, OSSL_PARAM *param,
311 OSSL_PARAM_ALIGNED_BLOCK *blk,
312 OSSL_PARAM_ALIGNED_BLOCK *secure)
314 int i, num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
315 OSSL_PARAM_BLD_DEF *pd;
318 for (i = 0; i < num; i++) {
319 pd = sk_OSSL_PARAM_BLD_DEF_value(bld->params, i);
320 param[i].key = pd->key;
321 param[i].data_type = pd->type;
322 param[i].data_size = pd->size;
323 param[i].return_size = OSSL_PARAM_UNMODIFIED;
327 secure += pd->alloc_blocks;
330 blk += pd->alloc_blocks;
333 if (pd->bn != NULL) {
335 BN_bn2nativepad(pd->bn, (unsigned char *)p, pd->size);
336 } else if (pd->type == OSSL_PARAM_OCTET_PTR
337 || pd->type == OSSL_PARAM_UTF8_PTR) {
339 *(const void **)p = pd->string;
340 } else if (pd->type == OSSL_PARAM_OCTET_STRING
341 || pd->type == OSSL_PARAM_UTF8_STRING) {
342 if (pd->string != NULL)
343 memcpy(p, pd->string, pd->size);
345 memset(p, 0, pd->size);
346 if (pd->type == OSSL_PARAM_UTF8_STRING)
347 ((char *)p)[pd->size] = '\0';
349 /* Number, but could also be a NULL BIGNUM */
350 if (pd->size > sizeof(pd->num))
351 memset(p, 0, pd->size);
352 else if (pd->size > 0)
353 memcpy(p, &pd->num, pd->size);
356 param[i] = OSSL_PARAM_construct_end();
360 OSSL_PARAM *OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD *bld)
362 OSSL_PARAM_ALIGNED_BLOCK *blk, *s = NULL;
363 OSSL_PARAM *params, *last;
364 const int num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
365 const size_t p_blks = ossl_param_bytes_to_blocks((1 + num) * sizeof(*params));
366 const size_t total = OSSL_PARAM_ALIGN_SIZE * (p_blks + bld->total_blocks);
367 const size_t ss = OSSL_PARAM_ALIGN_SIZE * bld->secure_blocks;
370 s = OPENSSL_secure_malloc(ss);
372 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_SECURE_MALLOC_FAILURE);
376 params = OPENSSL_malloc(total);
377 if (params == NULL) {
378 ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
379 OPENSSL_secure_free(s);
382 blk = p_blks + (OSSL_PARAM_ALIGNED_BLOCK *)(params);
383 last = param_bld_convert(bld, params, blk, s);
384 ossl_param_set_secure_block(last, s, ss);
386 /* Reset builder for reuse */
387 bld->total_blocks = 0;
388 bld->secure_blocks = 0;
389 free_all_params(bld);