From: Pauli Date: Wed, 21 Aug 2019 08:51:34 +0000 (+1000) Subject: Documentation updates in light of the KDF conversion X-Git-Tag: openssl-3.0.0-alpha1~1484 X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=commitdiff_plain;h=492939e5ef67441e87c66de2b13c79ba03f0fc5b;hp=e3405a4a9a5334cd636940a547a25c09ffc76009 Documentation updates in light of the KDF conversion Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/9662) --- diff --git a/doc/man3/EVP_KDF_CTX.pod b/doc/man3/EVP_KDF_CTX.pod index 1ae79bc1bd..4642b20713 100644 --- a/doc/man3/EVP_KDF_CTX.pod +++ b/doc/man3/EVP_KDF_CTX.pod @@ -2,9 +2,20 @@ =head1 NAME -EVP_KDF, EVP_KDF_CTX, EVP_KDF_CTX_new, EVP_KDF_CTX_new_id, EVP_KDF_CTX_free, -EVP_KDF_CTX_kdf, EVP_KDF_reset, EVP_KDF_ctrl, EVP_KDF_vctrl, EVP_KDF_ctrl_str, -EVP_KDF_size, EVP_KDF_derive, EVP_KDF_nid, EVP_KDF_name, +EVP_KDF, EVP_KDF_CTX, EVP_KDF_CTX_new, EVP_KDF_CTX_free, +EVP_KDF_CTX_kdf, EVP_KDF_reset, +EVP_KDF_size, EVP_KDF_derive, EVP_KDF_name, +EVP_KDF_CTX_dup, +EVP_KDF_CTX_get_params, +EVP_KDF_CTX_set_params, +EVP_KDF_do_all_ex, + EVP_KDF_fetch, + EVP_KDF_free, +EVP_KDF_get_params, +EVP_KDF_CTX_gettable_params, +EVP_KDF_CTX_settable_params, +EVP_KDF_gettable_params, +EVP_KDF_provider, EVP_KDF_up_ref, EVP_get_kdfbyname, EVP_get_kdfbynid, EVP_get_kdfbyobj - EVP KDF routines =head1 SYNOPSIS @@ -15,17 +26,27 @@ EVP_get_kdfbyname, EVP_get_kdfbynid, EVP_get_kdfbyobj - EVP KDF routines typedef struct evp_kdf_ctx_st EVP_KDF_CTX; EVP_KDF_CTX *EVP_KDF_CTX_new(const EVP_KDF *kdf); - EVP_KDF_CTX *EVP_KDF_CTX_new_id(int nid); const EVP_KDF *EVP_KDF_CTX_kdf(EVP_KDF_CTX *ctx); void EVP_KDF_CTX_free(EVP_KDF_CTX *ctx); + EVP_KDF_CTX *EVP_KDF_CTX_dup(const EVP_KDF_CTX *src); void EVP_KDF_reset(EVP_KDF_CTX *ctx); - int EVP_KDF_ctrl(EVP_KDF_CTX *ctx, int cmd, ...); - int EVP_KDF_vctrl(EVP_KDF_CTX *ctx, int cmd, va_list args); - int EVP_KDF_ctrl_str(EVP_KDF_CTX *ctx, const char *type, const char *value); size_t EVP_KDF_size(EVP_KDF_CTX *ctx); int EVP_KDF_derive(EVP_KDF_CTX *ctx, unsigned char *key, size_t keylen); - int EVP_KDF_nid(const EVP_KDF *kdf); const char *EVP_KDF_name(const EVP_KDF *kdf); + int EVP_KDF_up_ref(EVP_KDF *kdf); + void EVP_KDF_free(EVP_KDF *kdf); + EVP_KDF *EVP_KDF_fetch(OPENSSL_CTX *libctx, const char *algorithm, + const char *properties); + void EVP_KDF_do_all_ex(OPENSSL_CTX *libctx, + void (*fn)(EVP_KDF *kdf, void *arg), + void *arg); + int EVP_KDF_get_params(EVP_KDF *kdf, OSSL_PARAM params[]); + int EVP_KDF_CTX_get_params(EVP_KDF_CTX *ctx, OSSL_PARAM params[]); + int EVP_KDF_CTX_set_params(EVP_KDF_CTX *ctx, const OSSL_PARAM params[]); + const OSSL_PARAM *EVP_KDF_gettable_params(const EVP_KDF *kdf); + const OSSL_PARAM *EVP_KDF_CTX_gettable_params(const EVP_KDF *kdf); + const OSSL_PARAM *EVP_KDF_CTX_settable_params(const EVP_KDF *kdf); + const OSSL_PROVIDER *EVP_KDF_provider(const EVP_KDF *kdf); const EVP_KDF *EVP_get_kdfbyname(const char *name); const EVP_KDF *EVP_get_kdfbynid(int nid); const EVP_KDF *EVP_get_kdfbyobj(const ASN1_OBJECT *o); @@ -35,9 +56,9 @@ EVP_get_kdfbyname, EVP_get_kdfbynid, EVP_get_kdfbyobj - EVP KDF routines The EVP KDF routines are a high level interface to Key Derivation Function algorithms and should be used instead of algorithm-specific functions. -After creating a C for the required algorithm using either -EVP_KDF_CTX_new() or EVP_KDF_CTX_new_id(), inputs to the algorithm are supplied -using calls to EVP_KDF_ctrl(), EVP_KDF_vctrl() or EVP_KDF_ctrl_str() before +After creating a C for the required algorithm using +EVP_KDF_CTX_new(), inputs to the algorithm are supplied +using calls to EVP_KDF_CTX_set_params() before calling EVP_KDF_derive() to derive the key. =head2 Types @@ -50,8 +71,6 @@ B is a context type that holds the algorithm inputs. EVP_KDF_CTX_new() creates a new context for the KDF type C. -EVP_KDF_CTX_new_id() creates a new context for the numerical KDF identity C. - EVP_KDF_CTX_free() frees up the context C. If C is C, nothing is done. @@ -63,19 +82,11 @@ C. EVP_KDF_reset() resets the context to the default state as if the context had just been created. -EVP_KDF_ctrl() is used to provide inputs to the KDF algorithm prior to +EVP_KDF_CTX_set_params() is used to provide inputs to the KDF algorithm prior to EVP_KDF_derive() being called. The inputs that may be provided will vary -depending on the KDF algorithm or its implementation. This functions takes -variable arguments, the exact expected arguments depend on C. +depending on the KDF algorithm or its implementation. See L below for a description of standard controls. -EVP_KDF_vctrl() is the variant of EVP_KDF_ctrl() that takes a C -argument instead of variadic arguments. - -EVP_KDF_ctrl_str() allows an application to send an algorithm specific control -operation to a context C in string form. This is intended to be used for -options specified on the command line or in text files. - EVP_KDF_derive() derives C bytes of key material and places it in the C buffer. If the algorithm produces a fixed amount of output then an error will occur unless the C parameter is equal to that output size, @@ -88,8 +99,6 @@ of output and C otherwise. If an error occurs then 0 is returned. For some algorithms an error may result if input parameters necessary to calculate a fixed output size have not yet been supplied. -EVP_KDF_nid() returns the numeric identity of the given KDF implementation. - EVP_KDF_name() returns the name of the given KDF implementation. =head2 Object database functions @@ -116,8 +125,6 @@ This control expects two arguments: C, C Some KDF implementations require a password. For those KDF implementations that support it, this control sets the password. -EVP_KDF_ctrl_str() takes two type strings for this control: - =over 4 =item "pass" @@ -140,8 +147,6 @@ support it, this control sets the salt. The default value, if any, is implementation dependent. -EVP_KDF_ctrl_str() takes two type strings for this control: - =over 4 =item "salt" @@ -163,10 +168,6 @@ Some KDF implementations require an iteration count. For those KDF implementatio The default value, if any, is implementation dependent. -EVP_KDF_ctrl_str() type string: "iter" - -The value string is expected to be a decimal number. - =item B This control expects one argument: C @@ -174,10 +175,6 @@ This control expects one argument: C Some KDF implementations use a MAC as an underlying computation algorithm, this control sets what the MAC algorithm should be. -EVP_KDF_ctrl_str() type string: "mac" - -The value string is expected to be the name of a MAC. - =item B This control expects one argument: C @@ -185,10 +182,6 @@ This control expects one argument: C For MAC implementations that use a message digest as an underlying computation algorithm, this control sets what the digest algorithm should be. -EVP_KDF_ctrl_str() type string: "digest" - -The value string is expected to be the name of a digest. - =item B This control expects two arguments: C, C @@ -196,8 +189,6 @@ This control expects two arguments: C, C Some KDF implementations require a key. For those KDF implementations that support it, this control sets the key. -EVP_KDF_ctrl_str() takes two type strings for this control: - =over 4 =item "key" @@ -220,10 +211,6 @@ those KDF implementations that support it, this control sets the MAC output size The default value, if any, is implementation dependent. -EVP_KDF_ctrl_str() type string: "outlen" - -The value string is expected to be a decimal number. - =item B This control expects one argument: C @@ -237,15 +224,11 @@ the key derivation will fail. The default value is implementation dependent. -EVP_KDF_ctrl_str() type string: "maxmem_bytes" - -The value string is expected to be a decimal number. - =back =head1 RETURN VALUES -EVP_KDF_CTX_new() and EVP_KDF_CTX_new_id() return either the newly allocated +EVP_KDF_CTX_new() returns either the newly allocated C structure or C if an error occurred. EVP_KDF_CTX_free() and EVP_KDF_reset() do not return a value. @@ -253,14 +236,9 @@ EVP_KDF_CTX_free() and EVP_KDF_reset() do not return a value. EVP_KDF_size() returns the output size. C is returned to indicate that the algorithm produces a variable amount of output; 0 to indicate failure. -EVP_KDF_nid() returns the numeric identity for the given C. - EVP_KDF_name() returns the name for the given C, if it has been added to the object database. -EVP_add_kdf() returns 1 if the given C was successfully added to -the object database, otherwise 0. - EVP_get_kdfbyname(), EVP_get_kdfbynid() and EVP_get_kdfbyobj() return the requested KDF implementation, if it exists in the object database, otherwise B.