diff options
author | Pauli <paul.dale@oracle.com> | 2019-07-17 16:59:09 +1000 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2019-07-17 16:59:09 +1000 |
commit | 3c93fbacf6f5abd63e1d1763e7da537ed87f2a5d (patch) | |
tree | 7be0c84f7781c3c2f6998bb88f955cb46010c593 /crypto | |
parent | 4bd8b24045e1b044a2696b0675a9120ac0384567 (diff) |
Parameter building utilities.
A fuller implementation of PARAMS_TEMPLATE as per #9266 but renamed.
This introduces a statis data type which can be used to constructor a
description of a parameter array. It can then be converted into a OSSL_PARAM
array and the allocated storage freed by a single call to OPENSSL_free.
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9305)
Diffstat (limited to 'crypto')
-rw-r--r-- | crypto/build.info | 2 | ||||
-rw-r--r-- | crypto/cpt_err.c | 18 | ||||
-rw-r--r-- | crypto/err/openssl.txt | 22 | ||||
-rw-r--r-- | crypto/param_build.c | 341 |
4 files changed, 381 insertions, 2 deletions
diff --git a/crypto/build.info b/crypto/build.info index 90ccbc8b54..088ec87310 100644 --- a/crypto/build.info +++ b/crypto/build.info @@ -68,7 +68,7 @@ SOURCE[../providers/fips]=$CORE_COMMON $UTIL_COMMON=\ cryptlib.c params.c bsearch.c ex_data.c o_str.c \ ctype.c threads_pthread.c threads_win.c threads_none.c initthread.c \ - context.c sparse_array.c $CPUIDASM + context.c sparse_array.c param_build.c $CPUIDASM $UTIL_DEFINE=$CPUIDDEF SOURCE[../libcrypto]=$UTIL_COMMON \ diff --git a/crypto/cpt_err.c b/crypto/cpt_err.c index 94081344ca..fdf0e6ebce 100644 --- a/crypto/cpt_err.c +++ b/crypto/cpt_err.c @@ -18,12 +18,30 @@ static const ERR_STRING_DATA CRYPTO_str_reasons[] = { "fips mode not supported"}, {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_ILLEGAL_HEX_DIGIT), "illegal hex digit"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_INSUFFICIENT_DATA_SPACE), + "insufficient data space"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_INSUFFICIENT_PARAM_SIZE), + "insufficient param size"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_INSUFFICIENT_SECURE_DATA_SPACE), + "insufficient secure data space"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_INVALID_NULL_ARGUMENT), + "invalid null argument"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_INVALID_OSSL_PARAM_TYPE), + "invalid ossl param type"}, {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_ODD_NUMBER_OF_DIGITS), "odd number of digits"}, {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_PROVIDER_ALREADY_EXISTS), "provider already exists"}, {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_PROVIDER_SECTION_ERROR), "provider section error"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_SECURE_MALLOC_FAILURE), + "secure malloc failure"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_STRING_TOO_LONG), "string too long"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_TOO_MANY_BYTES), "too many bytes"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_TOO_MANY_RECORDS), + "too many records"}, + {ERR_PACK(ERR_LIB_CRYPTO, 0, CRYPTO_R_ZERO_LENGTH_NUMBER), + "zero length number"}, {0, NULL} }; diff --git a/crypto/err/openssl.txt b/crypto/err/openssl.txt index 4608938ed5..8aa62a6c38 100644 --- a/crypto/err/openssl.txt +++ b/crypto/err/openssl.txt @@ -397,11 +397,21 @@ CRYPTO_F_OPENSSL_INIT_CRYPTO:116:OPENSSL_init_crypto CRYPTO_F_OPENSSL_LH_NEW:126:OPENSSL_LH_new CRYPTO_F_OPENSSL_SK_DEEP_COPY:127:OPENSSL_sk_deep_copy CRYPTO_F_OPENSSL_SK_DUP:128:OPENSSL_sk_dup +CRYPTO_F_OSSL_PARAM_BLD_PUSH_BN:143: +CRYPTO_F_OSSL_PARAM_BLD_PUSH_OCTET_PTR:144: +CRYPTO_F_OSSL_PARAM_BLD_PUSH_OCTET_STRING:145: +CRYPTO_F_OSSL_PARAM_BLD_PUSH_UTF8_PTR:146: +CRYPTO_F_OSSL_PARAM_BLD_PUSH_UTF8_STRING:147: +CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM:148: +CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM_EX:149: +CRYPTO_F_OSSL_PARAM_TYPE_TO_PARAM:150: CRYPTO_F_OSSL_PROVIDER_ACTIVATE:130:ossl_provider_activate CRYPTO_F_OSSL_PROVIDER_ADD_BUILTIN:132:OSSL_PROVIDER_add_builtin CRYPTO_F_OSSL_PROVIDER_ADD_PARAMETER:139:ossl_provider_add_parameter CRYPTO_F_OSSL_PROVIDER_NEW:131:ossl_provider_new CRYPTO_F_OSSL_PROVIDER_SET_MODULE_PATH:140:ossl_provider_set_module_path +CRYPTO_F_PARAM_PUSH:151: +CRYPTO_F_PARAM_PUSH_NUM:152: CRYPTO_F_PKEY_HMAC_INIT:123:pkey_hmac_init CRYPTO_F_PKEY_POLY1305_INIT:124:pkey_poly1305_init CRYPTO_F_PKEY_SIPHASH_INIT:125:pkey_siphash_init @@ -807,11 +817,11 @@ EVP_F_EVP_DIGESTUPDATE:231:EVP_DigestUpdate EVP_F_EVP_ENCRYPTDECRYPTUPDATE:219:evp_EncryptDecryptUpdate EVP_F_EVP_ENCRYPTFINAL_EX:127:EVP_EncryptFinal_ex EVP_F_EVP_ENCRYPTUPDATE:167:EVP_EncryptUpdate -EVP_F_EVP_KEYEXCH_FROM_DISPATCH:244:evp_keyexch_from_dispatch EVP_F_EVP_KDF_CTRL:224:EVP_KDF_ctrl EVP_F_EVP_KDF_CTRL_STR:225:EVP_KDF_ctrl_str EVP_F_EVP_KDF_CTX_NEW:240:EVP_KDF_CTX_new EVP_F_EVP_KDF_CTX_NEW_ID:226:EVP_KDF_CTX_new_id +EVP_F_EVP_KEYEXCH_FROM_DISPATCH:244:evp_keyexch_from_dispatch EVP_F_EVP_MAC_CTRL:209:EVP_MAC_ctrl EVP_F_EVP_MAC_CTRL_STR:210:EVP_MAC_ctrl_str EVP_F_EVP_MAC_CTX_DUP:211:EVP_MAC_CTX_dup @@ -2215,9 +2225,19 @@ CRMF_R_UNSUPPORTED_POPO_METHOD:116:unsupported popo method CRMF_R_UNSUPPORTED_POPO_NOT_ACCEPTED:117:unsupported popo not accepted CRYPTO_R_FIPS_MODE_NOT_SUPPORTED:101:fips mode not supported CRYPTO_R_ILLEGAL_HEX_DIGIT:102:illegal hex digit +CRYPTO_R_INSUFFICIENT_DATA_SPACE:106:insufficient data space +CRYPTO_R_INSUFFICIENT_PARAM_SIZE:107:insufficient param size +CRYPTO_R_INSUFFICIENT_SECURE_DATA_SPACE:108:insufficient secure data space +CRYPTO_R_INVALID_NULL_ARGUMENT:109:invalid null argument +CRYPTO_R_INVALID_OSSL_PARAM_TYPE:110:invalid ossl param type CRYPTO_R_ODD_NUMBER_OF_DIGITS:103:odd number of digits CRYPTO_R_PROVIDER_ALREADY_EXISTS:104:provider already exists CRYPTO_R_PROVIDER_SECTION_ERROR:105:provider section error +CRYPTO_R_SECURE_MALLOC_FAILURE:111:secure malloc failure +CRYPTO_R_STRING_TOO_LONG:112:string too long +CRYPTO_R_TOO_MANY_BYTES:113:too many bytes +CRYPTO_R_TOO_MANY_RECORDS:114:too many records +CRYPTO_R_ZERO_LENGTH_NUMBER:115:zero length number CT_R_BASE64_DECODE_ERROR:108:base64 decode error CT_R_INVALID_LOG_ID_LENGTH:100:invalid log id length CT_R_LOG_CONF_INVALID:109:log conf invalid diff --git a/crypto/param_build.c b/crypto/param_build.c new file mode 100644 index 0000000000..851b735896 --- /dev/null +++ b/crypto/param_build.c @@ -0,0 +1,341 @@ +/* + * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved. + * + * Licensed under the Apache License 2.0 (the "License"). You may not use + * this file except in compliance with the License. You can obtain a copy + * in the file LICENSE in the source distribution or at + * https://www.openssl.org/source/license.html + */ + +#include <string.h> +#include <openssl/err.h> +#include <openssl/cryptoerr.h> +#include <openssl/params.h> +#include "internal/cryptlib.h" +#include "internal/param_build.h" + +typedef union { + OSSL_UNION_ALIGN; +} OSSL_PARAM_BLD_BLOCK; + +#define ALIGN_SIZE sizeof(OSSL_PARAM_BLD_BLOCK) + +static size_t bytes_to_blocks(size_t bytes) +{ + return (bytes + ALIGN_SIZE - 1) / ALIGN_SIZE; +} + +static OSSL_PARAM_BLD_DEF *param_push(OSSL_PARAM_BLD *bld, const char *key, + int size, size_t alloc, int type, + int secure) +{ + OSSL_PARAM_BLD_DEF *pd; + + if (bld->curr >= OSSL_PARAM_BLD_MAX) { + CRYPTOerr(CRYPTO_F_PARAM_PUSH, CRYPTO_R_TOO_MANY_RECORDS); + return NULL; + } + pd = bld->params + bld->curr++; + memset(pd, 0, sizeof(*pd)); + pd->key = key; + pd->type = type; + pd->size = size; + pd->alloc_blocks = bytes_to_blocks(size); + if ((pd->secure = secure) != 0) + bld->secure_blocks += pd->alloc_blocks; + else + bld->total_blocks += pd->alloc_blocks; + return pd; +} + +static int param_push_num(OSSL_PARAM_BLD *bld, const char *key, + void *num, size_t size, int type) +{ + OSSL_PARAM_BLD_DEF *pd = param_push(bld, key, size, size, type, 0); + + if (pd == NULL) + return 0; + if (size > sizeof(pd->num)) { + CRYPTOerr(CRYPTO_F_PARAM_PUSH_NUM, CRYPTO_R_TOO_MANY_BYTES); + return 0; + } + memcpy(&pd->num, num, size); + return 1; +} + +void ossl_param_bld_init(OSSL_PARAM_BLD *bld) +{ + memset(bld, 0, sizeof(*bld)); +} + +int ossl_param_bld_push_int(OSSL_PARAM_BLD *bld, const char *key, int num) +{ + return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER); +} + +int ossl_param_bld_push_uint(OSSL_PARAM_BLD *bld, const char *key, + unsigned int num) +{ + return param_push_num(bld, key, &num, sizeof(num), + OSSL_PARAM_UNSIGNED_INTEGER); +} + +int ossl_param_bld_push_long(OSSL_PARAM_BLD *bld, const char *key, + long int num) +{ + return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER); +} + +int ossl_param_bld_push_ulong(OSSL_PARAM_BLD *bld, const char *key, + unsigned long int num) +{ + return param_push_num(bld, key, &num, sizeof(num), + OSSL_PARAM_UNSIGNED_INTEGER); +} + +int ossl_param_bld_push_int32(OSSL_PARAM_BLD *bld, const char *key, + int32_t num) +{ + return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER); +} + +int ossl_param_bld_push_uint32(OSSL_PARAM_BLD *bld, const char *key, + uint32_t num) +{ + return param_push_num(bld, key, &num, sizeof(num), + OSSL_PARAM_UNSIGNED_INTEGER); +} + +int ossl_param_bld_push_int64(OSSL_PARAM_BLD *bld, const char *key, + int64_t num) +{ + return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_INTEGER); +} + +int ossl_param_bld_push_uint64(OSSL_PARAM_BLD *bld, const char *key, + uint64_t num) +{ + return param_push_num(bld, key, &num, sizeof(num), + OSSL_PARAM_UNSIGNED_INTEGER); +} + +int ossl_param_bld_push_size_t(OSSL_PARAM_BLD *bld, const char *key, + size_t num) +{ + return param_push_num(bld, key, &num, sizeof(num), + OSSL_PARAM_UNSIGNED_INTEGER); +} + +int ossl_param_bld_push_double(OSSL_PARAM_BLD *bld, const char *key, + double num) +{ + return param_push_num(bld, key, &num, sizeof(num), OSSL_PARAM_REAL); +} + +int ossl_param_bld_push_BN(OSSL_PARAM_BLD *bld, const char *key, + const BIGNUM *bn) +{ + int sz = -1, secure = 0; + OSSL_PARAM_BLD_DEF *pd; + + if (bn != NULL) { + sz = BN_num_bytes(bn); + if (sz < 0) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_PUSH_BN, + CRYPTO_R_ZERO_LENGTH_NUMBER); + return 0; + } + if (BN_get_flags(bn, BN_FLG_SECURE) == BN_FLG_SECURE) + secure = 1; + } + pd = param_push(bld, key, sz, sz >= 0 ? sz : 0, + OSSL_PARAM_UNSIGNED_INTEGER, secure); + if (pd == NULL) + return 0; + pd->bn = bn; + return 1; +} + +int ossl_param_bld_push_utf8_string(OSSL_PARAM_BLD *bld, const char *key, + char *buf, size_t bsize) +{ + OSSL_PARAM_BLD_DEF *pd; + + if (bsize == 0) { + bsize = strlen(buf) + 1; + } else if (bsize > INT_MAX) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_PUSH_UTF8_STRING, + CRYPTO_R_STRING_TOO_LONG); + return 0; + } + pd = param_push(bld, key, bsize, bsize, OSSL_PARAM_UTF8_STRING, 0); + if (pd == NULL) + return 0; + pd->string = buf; + return 1; +} + +int ossl_param_bld_push_utf8_ptr(OSSL_PARAM_BLD *bld, const char *key, + char *buf, size_t bsize) +{ + OSSL_PARAM_BLD_DEF *pd; + + if (bsize == 0) { + bsize = strlen(buf) + 1; + } else if (bsize > INT_MAX) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_PUSH_UTF8_PTR, + CRYPTO_R_STRING_TOO_LONG); + return 0; + } + pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_UTF8_PTR, 0); + if (pd == NULL) + return 0; + pd->string = buf; + return 1; +} + +int ossl_param_bld_push_octet_string(OSSL_PARAM_BLD *bld, const char *key, + void *buf, size_t bsize) +{ + OSSL_PARAM_BLD_DEF *pd; + + if (bsize > INT_MAX) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_PUSH_OCTET_STRING, + CRYPTO_R_STRING_TOO_LONG); + return 0; + } + pd = param_push(bld, key, bsize, bsize, OSSL_PARAM_OCTET_STRING, 0); + if (pd == NULL) + return 0; + pd->string = buf; + return 1; +} + +int ossl_param_bld_push_octet_ptr(OSSL_PARAM_BLD *bld, const char *key, + void *buf, size_t bsize) +{ + OSSL_PARAM_BLD_DEF *pd; + + if (bsize > INT_MAX) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_PUSH_OCTET_PTR, + CRYPTO_R_STRING_TOO_LONG); + return 0; + } + pd = param_push(bld, key, bsize, sizeof(buf), OSSL_PARAM_OCTET_PTR, 0); + if (pd == NULL) + return 0; + pd->string = buf; + return 1; +} + +static OSSL_PARAM *param_bld_convert(OSSL_PARAM_BLD *bld, OSSL_PARAM *param, + OSSL_PARAM_BLD_BLOCK *blk, + OSSL_PARAM_BLD_BLOCK *secure) +{ + size_t i; + OSSL_PARAM_BLD_DEF *pd; + void *p; + + for (i = 0; i < bld->curr; i++) { + pd = bld->params + i; + param[i].key = pd->key; + param[i].data_type = pd->type; + param[i].data_size = pd->size; + param[i].return_size = 0; + + if (pd->secure) { + p = secure; + secure += pd->alloc_blocks; + } else { + p = blk; + blk += pd->alloc_blocks; + } + param[i].data = p; + if (pd->bn != NULL) { + /* BIGNUM */ + BN_bn2nativepad(pd->bn, (unsigned char *)p, pd->size); + } else if (pd->type == OSSL_PARAM_OCTET_PTR + || pd->type == OSSL_PARAM_UTF8_PTR) { + /* PTR */ + *(void **)p = pd->string; + } else if (pd->type == OSSL_PARAM_OCTET_STRING + || pd->type == OSSL_PARAM_UTF8_STRING) { + if (pd->string != NULL) + memcpy(p, pd->string, pd->size); + else + memset(p, 0, pd->size); + } else { + /* Number, but could also be a NULL BIGNUM */ + if (pd->size > sizeof(pd->num)) + memset(p, 0, pd->size); + else if (pd->size > 0) + memcpy(p, &pd->num, pd->size); + } + } + param[i] = OSSL_PARAM_construct_end(); + return param; +} + +OSSL_PARAM *ossl_param_bld_to_param(OSSL_PARAM_BLD *bld, void **secure) +{ + OSSL_PARAM_BLD_BLOCK *blk, *s = NULL; + OSSL_PARAM *param; + const size_t p_blks = bytes_to_blocks((bld->curr + 1) * sizeof(*param)); + const size_t total = ALIGN_SIZE * (p_blks + bld->total_blocks); + + if (bld->secure_blocks > 0) { + if (secure == NULL) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM, + CRYPTO_R_INVALID_NULL_ARGUMENT); + return NULL; + } + s = OPENSSL_secure_malloc(bld->secure_blocks * ALIGN_SIZE); + if (s == NULL) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM, + CRYPTO_R_SECURE_MALLOC_FAILURE); + return NULL; + } + } + param = OPENSSL_malloc(total); + if (param == NULL) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM, ERR_R_MALLOC_FAILURE); + OPENSSL_secure_free(s); + return NULL; + } + if (secure != NULL) + *secure = s; + blk = p_blks + (OSSL_PARAM_BLD_BLOCK *)(param); + param_bld_convert(bld, param, blk, s); + return param; +} + +OSSL_PARAM *ossl_param_bld_to_param_ex(OSSL_PARAM_BLD *bld, OSSL_PARAM *params, + size_t param_n, void *data, + size_t data_n, void *secure, + size_t secure_n) +{ + if (params == NULL || data == NULL) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM_EX, + CRYPTO_R_INVALID_NULL_ARGUMENT); + return NULL; + } + if (param_n < bld->curr + 1) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM_EX, + CRYPTO_R_INSUFFICIENT_PARAM_SIZE); + return NULL; + } + if (data_n < ALIGN_SIZE * bld->total_blocks) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM_EX, + CRYPTO_R_INSUFFICIENT_DATA_SPACE); + return NULL; + } + if (bld->secure_blocks > 0 && secure_n < ALIGN_SIZE * bld->secure_blocks) { + CRYPTOerr(CRYPTO_F_OSSL_PARAM_BLD_TO_PARAM_EX, + CRYPTO_R_INSUFFICIENT_SECURE_DATA_SPACE); + return NULL; + } + param_bld_convert(bld, params, (OSSL_PARAM_BLD_BLOCK *)data, + (OSSL_PARAM_BLD_BLOCK *)secure); + return params; +} |