pbkdf2: convert to generated OSSL_PARAM parser

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/27923)

diff --git a/providers/implementations/kdfs/pbkdf2.c.in b/providers/implementations/kdfs/pbkdf2.c.in
index e612323d6329b910330f922a0bd128fac5fa6020..c12723196e89669d2b58dd6c4b2930de9e774fee 100644 (file)
--- a/providers/implementations/kdfs/pbkdf2.c.in
+++ b/providers/implementations/kdfs/pbkdf2.c.in
@@ -6,6 +6,9 @@
  * in the file LICENSE in the source distribution or at
  * https://www.openssl.org/source/license.html
  */
+{-
+use OpenSSL::paramnames qw(produce_param_decoder);
+-}
 
 /*
  * HMAC low level APIs are deprecated for public use, but still ok for internal
@@ -29,7 +32,6 @@
 #include "prov/implementations.h"
 #include "prov/provider_util.h"
 #include "prov/securitycheck.h"
-#include "pbkdf2.h"
 
 /* Constants specified in SP800-132 */
 #define KDF_PBKDF2_MIN_KEY_LEN_BITS 112
@@ -151,6 +153,7 @@ static void kdf_pbkdf2_init(KDF_PBKDF2 *ctx)
 {
     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
     OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
+    extern const int ossl_kdf_pbkdf2_default_checks;
 
     params[0] = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
                                                  SN_sha1, 0);
@@ -276,20 +279,31 @@ static int kdf_pbkdf2_derive(void *vctx, unsigned char *key, size_t keylen,
                          md, key, keylen, ctx->lower_bound_checks);
 }
 
+{- produce_param_decoder('pbkdf2_set_ctx_params',
+                         (['KDF_PARAM_PROPERTIES',  'propq',    'utf8_string'],
+                          ['ALG_PARAM_ENGINE',      'engine',   'utf8_string'],
+                          ['KDF_PARAM_DIGEST',      'digest',   'utf8_string'],
+                          ['KDF_PARAM_PASSWORD',    'pw',       'octet_string'],
+                          ['KDF_PARAM_SALT',        'salt',     'octet_string'],
+                          ['KDF_PARAM_ITER',        'iter',     'uint64'],
+                          ['KDF_PARAM_PKCS5',       'pkcs5',    'int'],
+                         )); -}
+
 static int kdf_pbkdf2_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 {
-    const OSSL_PARAM *p;
+    struct pbkdf2_set_ctx_params_st p;
     KDF_PBKDF2 *ctx = vctx;
     OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
     int pkcs5;
     uint64_t iter;
     const EVP_MD *md;
 
-    if (ossl_param_is_empty(params))
-        return 1;
+    if (ctx == NULL || !pbkdf2_set_ctx_params_decoder(params, &p))
+        return 0;
 
-    if (OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_DIGEST) != NULL) {
-        if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
+    if (p.digest != NULL) {
+        if (!ossl_prov_digest_load(&ctx->digest, p.digest,
+                                   p.propq, p.engine, provctx))
             return 0;
         md = ossl_prov_digest_md(&ctx->digest);
         if (EVP_MD_xof(md)) {
@@ -298,8 +312,8 @@ static int kdf_pbkdf2_set_ctx_params(void *vctx, const OSSL_PARAM params[])
         }
     }
 
-    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PKCS5)) != NULL) {
-        if (!OSSL_PARAM_get_int(p, &pkcs5))
+    if (p.pkcs5 != NULL) {
+        if (!OSSL_PARAM_get_int(p.pkcs5, &pkcs5))
             return 0;
         ctx->lower_bound_checks = pkcs5 == 0;
 #ifdef FIPS_MODULE
@@ -309,20 +323,19 @@ static int kdf_pbkdf2_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 #endif
     }
 
-    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PASSWORD)) != NULL)
-        if (!pbkdf2_set_membuf(&ctx->pass, &ctx->pass_len, p))
+    if (p.pw != NULL && !pbkdf2_set_membuf(&ctx->pass, &ctx->pass_len, p.pw))
             return 0;
 
-    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
-        if (!lower_bound_check_passed(ctx, (int)p->data_size, UINT64_MAX, SIZE_MAX,
+    if (p.salt != NULL) {
+        if (!lower_bound_check_passed(ctx, (int)p.salt->data_size, UINT64_MAX, SIZE_MAX,
                                       ctx->lower_bound_checks))
             return 0;
-        if (!pbkdf2_set_membuf(&ctx->salt, &ctx->salt_len, p))
+        if (!pbkdf2_set_membuf(&ctx->salt, &ctx->salt_len, p.salt))
             return 0;
     }
 
-    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_ITER)) != NULL) {
-        if (!OSSL_PARAM_get_uint64(p, &iter))
+    if (p.iter != NULL) {
+        if (!OSSL_PARAM_get_uint64(p.iter, &iter))
             return 0;
         if (!lower_bound_check_passed(ctx, INT_MAX, iter, SIZE_MAX,
                                       ctx->lower_bound_checks))
@@ -335,27 +348,26 @@ static int kdf_pbkdf2_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 static const OSSL_PARAM *kdf_pbkdf2_settable_ctx_params(ossl_unused void *ctx,
                                                         ossl_unused void *p_ctx)
 {
-    static const OSSL_PARAM known_settable_ctx_params[] = {
-        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
-        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
-        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PASSWORD, NULL, 0),
-        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
-        OSSL_PARAM_uint64(OSSL_KDF_PARAM_ITER, NULL),
-        OSSL_PARAM_int(OSSL_KDF_PARAM_PKCS5, NULL),
-        OSSL_PARAM_END
-    };
-    return known_settable_ctx_params;
+    return pbkdf2_set_ctx_params_list;
 }
 
+{- produce_param_decoder('pbkdf2_get_ctx_params',
+                         (['KDF_PARAM_SIZE',                    'size', 'size_t'],
+                          ['KDF_PARAM_FIPS_APPROVED_INDICATOR', 'ind',  'int'],
+                         )); -}
+
 static int kdf_pbkdf2_get_ctx_params(void *vctx, OSSL_PARAM params[])
 {
-    OSSL_PARAM *p;
+    KDF_PBKDF2 *ctx = vctx;
+    struct pbkdf2_get_ctx_params_st p;
+
+    if (ctx == NULL || !pbkdf2_get_ctx_params_decoder(params, &p))
+        return 0;
 
-    if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
-        if (!OSSL_PARAM_set_size_t(p, SIZE_MAX))
+    if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, SIZE_MAX))
             return 0;
 
-    if (!OSSL_FIPS_IND_GET_CTX_PARAM((KDF_PBKDF2 *) vctx, params))
+    if (!OSSL_FIPS_IND_GET_CTX_FROM_PARAM(ctx, p.ind))
         return 0;
     return 1;
 }
@@ -363,12 +375,7 @@ static int kdf_pbkdf2_get_ctx_params(void *vctx, OSSL_PARAM params[])
 static const OSSL_PARAM *kdf_pbkdf2_gettable_ctx_params(ossl_unused void *ctx,
                                                         ossl_unused void *p_ctx)
 {
-    static const OSSL_PARAM known_gettable_ctx_params[] = {
-        OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
-        OSSL_FIPS_IND_GETTABLE_CTX_PARAM()
-        OSSL_PARAM_END
-    };
-    return known_gettable_ctx_params;
+    return pbkdf2_get_ctx_params_list;
 }
 
 const OSSL_DISPATCH ossl_kdf_pbkdf2_functions[] = {

diff --git a/providers/implementations/kdfs/pbkdf2.h b/providers/implementations/kdfs/pbkdf2.h
deleted file mode 100644 (file)
index 7759c03..0000000
--- a/providers/implementations/kdfs/pbkdf2.h
+++ /dev/null
@@ -1,14 +0,0 @@
-/*
- * Copyright 2019-2021 The OpenSSL Project Authors. 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
- */
-
-/*
- * Available in pbkdfe_fips.c, and compiled with different values depending
- * on we're in the FIPS module or not.
- */
-extern const int ossl_kdf_pbkdf2_default_checks;

diff --git a/providers/implementations/kdfs/pbkdf2_fips.c b/providers/implementations/kdfs/pbkdf2_fips.c
index e43ef16455f197210a386bb7c39cc2f2f68e6207..fb25f18e2a31e8a7a28095695ff403bed7818dde 100644 (file)
--- a/providers/implementations/kdfs/pbkdf2_fips.c
+++ b/providers/implementations/kdfs/pbkdf2_fips.c
@@ -7,12 +7,11 @@
  * https://www.openssl.org/source/license.html
  */
 
-#include "pbkdf2.h"
-
 /*
  * For backwards compatibility reasons,
  * Extra checks are done by default in fips mode only.
  */
+extern const int ossl_kdf_pbkdf2_default_checks;
 #ifdef FIPS_MODULE
 const int ossl_kdf_pbkdf2_default_checks = 1;
 #else