]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/param_build.c
Fix typos found by codespell
[thirdparty/openssl.git] / crypto / param_build.c
CommitLineData
3c93fbac 1/*
fecb3aae 2 * Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved.
3c93fbac
P
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>
6d4e6009 15#include <openssl/types.h>
20c98cd4 16#include <openssl/safestack.h>
884314ca 17#include "internal/param_build_set.h"
3c93fbac 18
6d4e6009
P
19/*
20 * Special internal param type to indicate the end of an allocate OSSL_PARAM
21 * array.
22 */
7312ef3f 23
6d4e6009
P
24typedef 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
eb4129e1 35 * important so that all native types can be copied here without overrun.
6d4e6009
P
36 */
37 ossl_intmax_t i;
38 ossl_uintmax_t u;
39 double d;
40 } num;
41} OSSL_PARAM_BLD_DEF;
42
20c98cd4
P
43DEFINE_STACK_OF(OSSL_PARAM_BLD_DEF)
44
6d4e6009 45struct ossl_param_bld_st {
6d4e6009
P
46 size_t total_blocks;
47 size_t secure_blocks;
20c98cd4 48 STACK_OF(OSSL_PARAM_BLD_DEF) *params;
6d4e6009
P
49};
50
3c93fbac
P
51static OSSL_PARAM_BLD_DEF *param_push(OSSL_PARAM_BLD *bld, const char *key,
52 int size, size_t alloc, int type,
53 int secure)
54{
20c98cd4 55 OSSL_PARAM_BLD_DEF *pd = OPENSSL_zalloc(sizeof(*pd));
3c93fbac 56
e077455e 57 if (pd == NULL)
3c93fbac 58 return NULL;
3c93fbac
P
59 pd->key = key;
60 pd->type = type;
61 pd->size = size;
884314ca 62 pd->alloc_blocks = ossl_param_bytes_to_blocks(alloc);
3c93fbac
P
63 if ((pd->secure = secure) != 0)
64 bld->secure_blocks += pd->alloc_blocks;
65 else
66 bld->total_blocks += pd->alloc_blocks;
20c98cd4
P
67 if (sk_OSSL_PARAM_BLD_DEF_push(bld->params, pd) <= 0) {
68 OPENSSL_free(pd);
69 pd = NULL;
70 }
3c93fbac
P
71 return pd;
72}
73
74static 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
3831351d
P
79 if (pd == NULL) {
80 ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
3c93fbac 81 return 0;
3831351d 82 }
3c93fbac 83 if (size > sizeof(pd->num)) {
9311d0c4 84 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_MANY_BYTES);
3c93fbac
P
85 return 0;
86 }
87 memcpy(&pd->num, num, size);
88 return 1;
89}
90
6d4e6009 91OSSL_PARAM_BLD *OSSL_PARAM_BLD_new(void)
3c93fbac 92{
20c98cd4
P
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
105static 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));
6d4e6009
P
111}
112
113void OSSL_PARAM_BLD_free(OSSL_PARAM_BLD *bld)
114{
a6f8a834
MC
115 if (bld == NULL)
116 return;
20c98cd4
P
117 free_all_params(bld);
118 sk_OSSL_PARAM_BLD_DEF_free(bld->params);
6d4e6009 119 OPENSSL_free(bld);
3c93fbac
P
120}
121
110bff61 122int OSSL_PARAM_BLD_push_int(OSSL_PARAM_BLD *bld, const char *key, int num)
3c93fbac
P
123{
124 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
125}
126
110bff61 127int OSSL_PARAM_BLD_push_uint(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
128 unsigned int num)
129{
130 return param_push_num(bld, key, &num, sizeof(num),
131 OSSL_PARAM_UNSIGNED_INTEGER);
132}
133
110bff61 134int OSSL_PARAM_BLD_push_long(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
135 long int num)
136{
137 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
138}
139
110bff61 140int OSSL_PARAM_BLD_push_ulong(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
141 unsigned long int num)
142{
143 return param_push_num(bld, key, &num, sizeof(num),
144 OSSL_PARAM_UNSIGNED_INTEGER);
145}
146
110bff61 147int OSSL_PARAM_BLD_push_int32(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
148 int32_t num)
149{
150 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
151}
152
110bff61 153int OSSL_PARAM_BLD_push_uint32(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
154 uint32_t num)
155{
156 return param_push_num(bld, key, &num, sizeof(num),
157 OSSL_PARAM_UNSIGNED_INTEGER);
158}
159
110bff61 160int OSSL_PARAM_BLD_push_int64(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
161 int64_t num)
162{
163 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
164}
165
110bff61 166int OSSL_PARAM_BLD_push_uint64(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
167 uint64_t num)
168{
169 return param_push_num(bld, key, &num, sizeof(num),
170 OSSL_PARAM_UNSIGNED_INTEGER);
171}
172
110bff61 173int OSSL_PARAM_BLD_push_size_t(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
174 size_t num)
175{
176 return param_push_num(bld, key, &num, sizeof(num),
177 OSSL_PARAM_UNSIGNED_INTEGER);
178}
179
5fdaa38f
P
180int OSSL_PARAM_BLD_push_time_t(OSSL_PARAM_BLD *bld, const char *key,
181 time_t num)
182{
183 return param_push_num(bld, key, &num, sizeof(num),
184 OSSL_PARAM_INTEGER);
185}
186
110bff61 187int OSSL_PARAM_BLD_push_double(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
188 double num)
189{
190 return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_REAL);
191}
192
17898ec6
RL
193static int push_BN(OSSL_PARAM_BLD *bld, const char *key,
194 const BIGNUM *bn, size_t sz, int type)
ac23078b
P
195{
196 int n, secure = 0;
3c93fbac
P
197 OSSL_PARAM_BLD_DEF *pd;
198
17898ec6
RL
199 if (!ossl_assert(type == OSSL_PARAM_UNSIGNED_INTEGER
200 || type == OSSL_PARAM_INTEGER))
201 return 0;
202
3c93fbac 203 if (bn != NULL) {
17898ec6 204 if (type == OSSL_PARAM_UNSIGNED_INTEGER && BN_is_negative(bn)) {
db65eabe 205 ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_UNSUPPORTED,
17898ec6 206 "Negative big numbers are unsupported for OSSL_PARAM_UNSIGNED_INTEGER");
db65eabe
RL
207 return 0;
208 }
209
ac23078b
P
210 n = BN_num_bytes(bn);
211 if (n < 0) {
9311d0c4 212 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_ZERO_LENGTH_NUMBER);
ac23078b
P
213 return 0;
214 }
215 if (sz < (size_t)n) {
9311d0c4 216 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_SMALL_BUFFER);
3c93fbac
P
217 return 0;
218 }
219 if (BN_get_flags(bn, BN_FLG_SECURE) == BN_FLG_SECURE)
220 secure = 1;
c455f87a
RL
221
222 /* The BIGNUM is zero, we must transfer at least one byte */
223 if (sz == 0)
224 sz++;
3c93fbac 225 }
17898ec6 226 pd = param_push(bld, key, sz, sz, type, secure);
3c93fbac
P
227 if (pd == NULL)
228 return 0;
229 pd->bn = bn;
230 return 1;
231}
232
17898ec6
RL
233int OSSL_PARAM_BLD_push_BN(OSSL_PARAM_BLD *bld, const char *key,
234 const BIGNUM *bn)
235{
236 if (BN_is_negative(bn))
237 return push_BN(bld, key, bn, bn == NULL ? 0 : BN_num_bytes(bn) + 1,
238 OSSL_PARAM_INTEGER);
239 return push_BN(bld, key, bn, bn == NULL ? 0 : BN_num_bytes(bn),
240 OSSL_PARAM_UNSIGNED_INTEGER);
241}
242
243int OSSL_PARAM_BLD_push_BN_pad(OSSL_PARAM_BLD *bld, const char *key,
244 const BIGNUM *bn, size_t sz)
245{
246 if (BN_is_negative(bn))
247 return push_BN(bld, key, bn, bn == NULL ? 0 : BN_num_bytes(bn),
248 OSSL_PARAM_INTEGER);
249 return push_BN(bld, key, bn, sz, OSSL_PARAM_UNSIGNED_INTEGER);
250}
251
110bff61 252int OSSL_PARAM_BLD_push_utf8_string(OSSL_PARAM_BLD *bld, const char *key,
5fa7789f 253 const char *buf, size_t bsize)
3c93fbac
P
254{
255 OSSL_PARAM_BLD_DEF *pd;
b6b55ad9 256 int secure;
3c93fbac
P
257
258 if (bsize == 0) {
6be27456 259 bsize = strlen(buf);
3c93fbac 260 } else if (bsize > INT_MAX) {
9311d0c4 261 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
3c93fbac
P
262 return 0;
263 }
b6b55ad9
P
264 secure = CRYPTO_secure_allocated(buf);
265 pd = param_push(bld, key, bsize, bsize + 1, OSSL_PARAM_UTF8_STRING, secure);
3c93fbac
P
266 if (pd == NULL)
267 return 0;
268 pd->string = buf;
269 return 1;
270}
271
110bff61 272int OSSL_PARAM_BLD_push_utf8_ptr(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
273 char *buf, size_t bsize)
274{
275 OSSL_PARAM_BLD_DEF *pd;
276
277 if (bsize == 0) {
6be27456 278 bsize = strlen(buf);
3c93fbac 279 } else if (bsize > INT_MAX) {
9311d0c4 280 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
3c93fbac
P
281 return 0;
282 }
283 pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_UTF8_PTR, 0);
284 if (pd == NULL)
285 return 0;
286 pd->string = buf;
287 return 1;
288}
289
110bff61 290int OSSL_PARAM_BLD_push_octet_string(OSSL_PARAM_BLD *bld, const char *key,
5fa7789f 291 const void *buf, size_t bsize)
3c93fbac
P
292{
293 OSSL_PARAM_BLD_DEF *pd;
b6b55ad9 294 int secure;
3c93fbac
P
295
296 if (bsize > INT_MAX) {
9311d0c4 297 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
3c93fbac
P
298 return 0;
299 }
b6b55ad9
P
300 secure = CRYPTO_secure_allocated(buf);
301 pd = param_push(bld, key, bsize, bsize, OSSL_PARAM_OCTET_STRING, secure);
3c93fbac
P
302 if (pd == NULL)
303 return 0;
304 pd->string = buf;
305 return 1;
306}
307
110bff61 308int OSSL_PARAM_BLD_push_octet_ptr(OSSL_PARAM_BLD *bld, const char *key,
3c93fbac
P
309 void *buf, size_t bsize)
310{
311 OSSL_PARAM_BLD_DEF *pd;
312
313 if (bsize > INT_MAX) {
9311d0c4 314 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
3c93fbac
P
315 return 0;
316 }
317 pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_OCTET_PTR, 0);
318 if (pd == NULL)
319 return 0;
320 pd->string = buf;
321 return 1;
322}
323
324static OSSL_PARAM *param_bld_convert(OSSL_PARAM_BLD *bld, OSSL_PARAM *param,
884314ca
SL
325 OSSL_PARAM_ALIGNED_BLOCK *blk,
326 OSSL_PARAM_ALIGNED_BLOCK *secure)
3c93fbac 327{
20c98cd4 328 int i, num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
3c93fbac
P
329 OSSL_PARAM_BLD_DEF *pd;
330 void *p;
331
20c98cd4
P
332 for (i = 0; i < num; i++) {
333 pd = sk_OSSL_PARAM_BLD_DEF_value(bld->params, i);
3c93fbac
P
334 param[i].key = pd->key;
335 param[i].data_type = pd->type;
336 param[i].data_size = pd->size;
2baf2d81 337 param[i].return_size = OSSL_PARAM_UNMODIFIED;
3c93fbac
P
338
339 if (pd->secure) {
340 p = secure;
341 secure += pd->alloc_blocks;
342 } else {
343 p = blk;
344 blk += pd->alloc_blocks;
345 }
346 param[i].data = p;
347 if (pd->bn != NULL) {
348 /* BIGNUM */
17898ec6
RL
349 if (pd->type == OSSL_PARAM_UNSIGNED_INTEGER)
350 BN_bn2nativepad(pd->bn, (unsigned char *)p, pd->size);
351 else
352 BN_signed_bn2native(pd->bn, (unsigned char *)p, pd->size);
3c93fbac
P
353 } else if (pd->type == OSSL_PARAM_OCTET_PTR
354 || pd->type == OSSL_PARAM_UTF8_PTR) {
355 /* PTR */
d32d3048 356 *(const void **)p = pd->string;
3c93fbac
P
357 } else if (pd->type == OSSL_PARAM_OCTET_STRING
358 || pd->type == OSSL_PARAM_UTF8_STRING) {
359 if (pd->string != NULL)
360 memcpy(p, pd->string, pd->size);
361 else
362 memset(p, 0, pd->size);
6be27456
RL
363 if (pd->type == OSSL_PARAM_UTF8_STRING)
364 ((char *)p)[pd->size] = '\0';
3c93fbac
P
365 } else {
366 /* Number, but could also be a NULL BIGNUM */
367 if (pd->size > sizeof(pd->num))
368 memset(p, 0, pd->size);
369 else if (pd->size > 0)
370 memcpy(p, &pd->num, pd->size);
371 }
372 }
373 param[i] = OSSL_PARAM_construct_end();
7312ef3f 374 return param + i;
3c93fbac
P
375}
376
110bff61 377OSSL_PARAM *OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD *bld)
3c93fbac 378{
884314ca 379 OSSL_PARAM_ALIGNED_BLOCK *blk, *s = NULL;
7312ef3f 380 OSSL_PARAM *params, *last;
20c98cd4 381 const int num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
884314ca
SL
382 const size_t p_blks = ossl_param_bytes_to_blocks((1 + num) * sizeof(*params));
383 const size_t total = OSSL_PARAM_ALIGN_SIZE * (p_blks + bld->total_blocks);
384 const size_t ss = OSSL_PARAM_ALIGN_SIZE * bld->secure_blocks;
3c93fbac 385
7312ef3f
P
386 if (ss > 0) {
387 s = OPENSSL_secure_malloc(ss);
3c93fbac 388 if (s == NULL) {
9311d0c4 389 ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_SECURE_MALLOC_FAILURE);
3c93fbac
P
390 return NULL;
391 }
392 }
7312ef3f
P
393 params = OPENSSL_malloc(total);
394 if (params == NULL) {
3c93fbac
P
395 OPENSSL_secure_free(s);
396 return NULL;
397 }
884314ca 398 blk = p_blks + (OSSL_PARAM_ALIGNED_BLOCK *)(params);
7312ef3f 399 last = param_bld_convert(bld, params, blk, s);
884314ca 400 ossl_param_set_secure_block(last, s, ss);
6d4e6009 401
20c98cd4
P
402 /* Reset builder for reuse */
403 bld->total_blocks = 0;
404 bld->secure_blocks = 0;
405 free_all_params(bld);
7312ef3f
P
406 return params;
407}