crypto/param_build.c

   1 /*
   2  * Copyright 2019-2021 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          * imporant 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
  51 static 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 {
  55     OSSL_PARAM_BLD_DEF *pd = OPENSSL_zalloc(sizeof(*pd));
  56
  57     if (pd == NULL) {
  58         ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
  59         return NULL;
  60     }
  61     pd->key = key;
  62     pd->type = type;
  63     pd->size = size;
  64     pd->alloc_blocks = ossl_param_bytes_to_blocks(alloc);
  65     if ((pd->secure = secure) != 0)
  66         bld->secure_blocks += pd->alloc_blocks;
  67     else
  68         bld->total_blocks += pd->alloc_blocks;
  69     if (sk_OSSL_PARAM_BLD_DEF_push(bld->params, pd) <= 0) {
  70         OPENSSL_free(pd);
  71         pd = NULL;
  72     }
  73     return pd;
  74 }
  75
  76 static int param_push_num(OSSL_PARAM_BLD *bld, const char *key,
  77                           void *num, size_t size, int type)
  78 {
  79     OSSL_PARAM_BLD_DEF *pd = param_push(bld, key, size, size, type, 0);
  80
  81     if (pd == NULL)
  82         return 0;
  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
  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
 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
 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
 122 int OSSL_PARAM_BLD_push_int(OSSL_PARAM_BLD *bld, const char *key, int num)
 123 {
 124     return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
 125 }
 126
 127 int OSSL_PARAM_BLD_push_uint(OSSL_PARAM_BLD *bld, const char *key,
 128                              unsigned int num)
 129 {
 130     return param_push_num(bld, key, &num, sizeof(num),
 131                           OSSL_PARAM_UNSIGNED_INTEGER);
 132 }
 133
 134 int OSSL_PARAM_BLD_push_long(OSSL_PARAM_BLD *bld, const char *key,
 135                              long int num)
 136 {
 137     return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
 138 }
 139
 140 int OSSL_PARAM_BLD_push_ulong(OSSL_PARAM_BLD *bld, const char *key,
 141                               unsigned long int num)
 142 {
 143     return param_push_num(bld, key, &num, sizeof(num),
 144                           OSSL_PARAM_UNSIGNED_INTEGER);
 145 }
 146
 147 int OSSL_PARAM_BLD_push_int32(OSSL_PARAM_BLD *bld, const char *key,
 148                               int32_t num)
 149 {
 150     return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
 151 }
 152
 153 int OSSL_PARAM_BLD_push_uint32(OSSL_PARAM_BLD *bld, const char *key,
 154                                uint32_t num)
 155 {
 156     return param_push_num(bld, key, &num, sizeof(num),
 157                           OSSL_PARAM_UNSIGNED_INTEGER);
 158 }
 159
 160 int OSSL_PARAM_BLD_push_int64(OSSL_PARAM_BLD *bld, const char *key,
 161                               int64_t num)
 162 {
 163     return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER);
 164 }
 165
 166 int OSSL_PARAM_BLD_push_uint64(OSSL_PARAM_BLD *bld, const char *key,
 167                                uint64_t num)
 168 {
 169     return param_push_num(bld, key, &num, sizeof(num),
 170                           OSSL_PARAM_UNSIGNED_INTEGER);
 171 }
 172
 173 int OSSL_PARAM_BLD_push_size_t(OSSL_PARAM_BLD *bld, const char *key,
 174                                size_t num)
 175 {
 176     return param_push_num(bld, key, &num, sizeof(num),
 177                           OSSL_PARAM_UNSIGNED_INTEGER);
 178 }
 179
 180 int 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
 187 int OSSL_PARAM_BLD_push_double(OSSL_PARAM_BLD *bld, const char *key,
 188                                double num)
 189 {
 190     return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_REAL);
 191 }
 192
 193 int OSSL_PARAM_BLD_push_BN(OSSL_PARAM_BLD *bld, const char *key,
 194                            const BIGNUM *bn)
 195 {
 196     return OSSL_PARAM_BLD_push_BN_pad(bld, key, bn,
 197                                       bn == NULL ? 0 : BN_num_bytes(bn));
 198 }
 199
 200 int OSSL_PARAM_BLD_push_BN_pad(OSSL_PARAM_BLD *bld, const char *key,
 201                                const BIGNUM *bn, size_t sz)
 202 {
 203     int n, secure = 0;
 204     OSSL_PARAM_BLD_DEF *pd;
 205
 206     if (bn != NULL) {
 207         n = BN_num_bytes(bn);
 208         if (n < 0) {
 209             ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_ZERO_LENGTH_NUMBER);
 210             return 0;
 211         }
 212         if (sz < (size_t)n) {
 213             ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_SMALL_BUFFER);
 214             return 0;
 215         }
 216         if (BN_get_flags(bn, BN_FLG_SECURE) == BN_FLG_SECURE)
 217             secure = 1;
 218     }
 219     pd = param_push(bld, key, sz, sz, OSSL_PARAM_UNSIGNED_INTEGER, secure);
 220     if (pd == NULL)
 221         return 0;
 222     pd->bn = bn;
 223     return 1;
 224 }
 225
 226 int OSSL_PARAM_BLD_push_utf8_string(OSSL_PARAM_BLD *bld, const char *key,
 227                                     const char *buf, size_t bsize)
 228 {
 229     OSSL_PARAM_BLD_DEF *pd;
 230     int secure;
 231
 232     if (bsize == 0) {
 233         bsize = strlen(buf);
 234     } else if (bsize > INT_MAX) {
 235         ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
 236         return 0;
 237     }
 238     secure = CRYPTO_secure_allocated(buf);
 239     pd = param_push(bld, key, bsize, bsize + 1, OSSL_PARAM_UTF8_STRING, secure);
 240     if (pd == NULL)
 241         return 0;
 242     pd->string = buf;
 243     return 1;
 244 }
 245
 246 int OSSL_PARAM_BLD_push_utf8_ptr(OSSL_PARAM_BLD *bld, const char *key,
 247                                  char *buf, size_t bsize)
 248 {
 249     OSSL_PARAM_BLD_DEF *pd;
 250
 251     if (bsize == 0) {
 252         bsize = strlen(buf);
 253     } else if (bsize > INT_MAX) {
 254         ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
 255         return 0;
 256     }
 257     pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_UTF8_PTR, 0);
 258     if (pd == NULL)
 259         return 0;
 260     pd->string = buf;
 261     return 1;
 262 }
 263
 264 int OSSL_PARAM_BLD_push_octet_string(OSSL_PARAM_BLD *bld, const char *key,
 265                                      const void *buf, size_t bsize)
 266 {
 267     OSSL_PARAM_BLD_DEF *pd;
 268     int secure;
 269
 270     if (bsize > INT_MAX) {
 271         ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
 272         return 0;
 273     }
 274     secure = CRYPTO_secure_allocated(buf);
 275     pd = param_push(bld, key, bsize, bsize, OSSL_PARAM_OCTET_STRING, secure);
 276     if (pd == NULL)
 277         return 0;
 278     pd->string = buf;
 279     return 1;
 280 }
 281
 282 int OSSL_PARAM_BLD_push_octet_ptr(OSSL_PARAM_BLD *bld, const char *key,
 283                                   void *buf, size_t bsize)
 284 {
 285     OSSL_PARAM_BLD_DEF *pd;
 286
 287     if (bsize > INT_MAX) {
 288         ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_STRING_TOO_LONG);
 289         return 0;
 290     }
 291     pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_OCTET_PTR, 0);
 292     if (pd == NULL)
 293         return 0;
 294     pd->string = buf;
 295     return 1;
 296 }
 297
 298 static OSSL_PARAM *param_bld_convert(OSSL_PARAM_BLD *bld, OSSL_PARAM *param,
 299                                      OSSL_PARAM_ALIGNED_BLOCK *blk,
 300                                      OSSL_PARAM_ALIGNED_BLOCK *secure)
 301 {
 302     int i, num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
 303     OSSL_PARAM_BLD_DEF *pd;
 304     void *p;
 305
 306     for (i = 0; i < num; i++) {
 307         pd = sk_OSSL_PARAM_BLD_DEF_value(bld->params, i);
 308         param[i].key = pd->key;
 309         param[i].data_type = pd->type;
 310         param[i].data_size = pd->size;
 311         param[i].return_size = OSSL_PARAM_UNMODIFIED;
 312
 313         if (pd->secure) {
 314             p = secure;
 315             secure += pd->alloc_blocks;
 316         } else {
 317             p = blk;
 318             blk += pd->alloc_blocks;
 319         }
 320         param[i].data = p;
 321         if (pd->bn != NULL) {
 322             /* BIGNUM */
 323             BN_bn2nativepad(pd->bn, (unsigned char *)p, pd->size);
 324         } else if (pd->type == OSSL_PARAM_OCTET_PTR
 325                    || pd->type == OSSL_PARAM_UTF8_PTR) {
 326             /* PTR */
 327             *(const void **)p = pd->string;
 328         } else if (pd->type == OSSL_PARAM_OCTET_STRING
 329                    || pd->type == OSSL_PARAM_UTF8_STRING) {
 330             if (pd->string != NULL)
 331                 memcpy(p, pd->string, pd->size);
 332             else
 333                 memset(p, 0, pd->size);
 334             if (pd->type == OSSL_PARAM_UTF8_STRING)
 335                 ((char *)p)[pd->size] = '\0';
 336         } else {
 337             /* Number, but could also be a NULL BIGNUM */
 338             if (pd->size > sizeof(pd->num))
 339                 memset(p, 0, pd->size);
 340             else if (pd->size > 0)
 341                 memcpy(p, &pd->num, pd->size);
 342         }
 343     }
 344     param[i] = OSSL_PARAM_construct_end();
 345     return param + i;
 346 }
 347
 348 OSSL_PARAM *OSSL_PARAM_BLD_to_param(OSSL_PARAM_BLD *bld)
 349 {
 350     OSSL_PARAM_ALIGNED_BLOCK *blk, *s = NULL;
 351     OSSL_PARAM *params, *last;
 352     const int num = sk_OSSL_PARAM_BLD_DEF_num(bld->params);
 353     const size_t p_blks = ossl_param_bytes_to_blocks((1 + num) * sizeof(*params));
 354     const size_t total = OSSL_PARAM_ALIGN_SIZE * (p_blks + bld->total_blocks);
 355     const size_t ss = OSSL_PARAM_ALIGN_SIZE * bld->secure_blocks;
 356
 357     if (ss > 0) {
 358         s = OPENSSL_secure_malloc(ss);
 359         if (s == NULL) {
 360             ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_SECURE_MALLOC_FAILURE);
 361             return NULL;
 362         }
 363     }
 364     params = OPENSSL_malloc(total);
 365     if (params == NULL) {
 366         ERR_raise(ERR_LIB_CRYPTO, ERR_R_MALLOC_FAILURE);
 367         OPENSSL_secure_free(s);
 368         return NULL;
 369     }
 370     blk = p_blks + (OSSL_PARAM_ALIGNED_BLOCK *)(params);
 371     last = param_bld_convert(bld, params, blk, s);
 372     ossl_param_set_secure_block(last, s, ss);
 373
 374     /* Reset builder for reuse */
 375     bld->total_blocks = 0;
 376     bld->secure_blocks = 0;
 377     free_all_params(bld);
 378     return params;
 379 }
 380
 381 void OSSL_PARAM_BLD_free_params(OSSL_PARAM *params)
 382 {
 383     OSSL_PARAM_free(params);
 384 }