diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_KDF.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_KDF.3 | 253 |
1 files changed, 82 insertions, 171 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_KDF.3 b/secure/lib/libcrypto/man/man3/EVP_KDF.3 index 657e4e61d7da..fa51ec4eede1 100644 --- a/secure/lib/libcrypto/man/man3/EVP_KDF.3 +++ b/secure/lib/libcrypto/man/man3/EVP_KDF.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,75 +52,15 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "EVP_KDF 3ossl" -.TH EVP_KDF 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EVP_KDF 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME EVP_KDF, EVP_KDF_fetch, EVP_KDF_free, EVP_KDF_up_ref, EVP_KDF_CTX, EVP_KDF_CTX_new, EVP_KDF_CTX_free, EVP_KDF_CTX_dup, EVP_KDF_CTX_reset, EVP_KDF_derive, @@ -147,7 +71,7 @@ EVP_KDF_CTX_get_params, EVP_KDF_CTX_set_params, EVP_KDF_do_all_provided, EVP_KDF_get_params, EVP_KDF_gettable_params, EVP_KDF_gettable_ctx_params, EVP_KDF_settable_ctx_params, EVP_KDF_CTX_gettable_params, EVP_KDF_CTX_settable_params \- EVP KDF routines -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/kdf.h> @@ -155,7 +79,7 @@ EVP_KDF_CTX_gettable_params, EVP_KDF_CTX_settable_params \- EVP KDF routines \& typedef struct evp_kdf_st EVP_KDF; \& 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(EVP_KDF *kdf); \& 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); @@ -187,46 +111,46 @@ EVP_KDF_CTX_gettable_params, EVP_KDF_CTX_settable_params \- EVP KDF routines \& const OSSL_PARAM *EVP_KDF_CTX_settable_params(const EVP_KDF *kdf); \& const OSSL_PROVIDER *EVP_KDF_get0_provider(const EVP_KDF *kdf); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -The \s-1EVP KDF\s0 routines are a high-level interface to Key Derivation Function +The EVP KDF routines are a high-level interface to Key Derivation Function algorithms and should be used instead of algorithm-specific functions. .PP -After creating a \fB\s-1EVP_KDF_CTX\s0\fR for the required algorithm using +After creating a \fBEVP_KDF_CTX\fR for the required algorithm using \&\fBEVP_KDF_CTX_new()\fR, inputs to the algorithm are supplied either by passing them as part of the \fBEVP_KDF_derive()\fR call or using calls to \fBEVP_KDF_CTX_set_params()\fR before calling \fBEVP_KDF_derive()\fR to derive the key. -.SS "Types" +.SS Types .IX Subsection "Types" -\&\fB\s-1EVP_KDF\s0\fR is a type that holds the implementation of a \s-1KDF.\s0 +\&\fBEVP_KDF\fR is a type that holds the implementation of a KDF. .PP -\&\fB\s-1EVP_KDF_CTX\s0\fR is a context type that holds the algorithm inputs. +\&\fBEVP_KDF_CTX\fR is a context type that holds the algorithm inputs. .SS "Algorithm implementation fetching" .IX Subsection "Algorithm implementation fetching" -\&\fBEVP_KDF_fetch()\fR fetches an implementation of a \s-1KDF\s0 \fIalgorithm\fR, given +\&\fBEVP_KDF_fetch()\fR fetches an implementation of a KDF \fIalgorithm\fR, given a library context \fIlibctx\fR and a set of \fIproperties\fR. -See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7) for further information. +See "ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for further information. .PP -See \*(L"Key Derivation Function (\s-1KDF\s0)\*(R" in \fBOSSL_PROVIDER\-default\fR\|(7) for the lists of +See "Key Derivation Function (KDF)" in \fBOSSL_PROVIDER\-default\fR\|(7) for the lists of algorithms supported by the default provider. .PP The returned value must eventually be freed with \&\fBEVP_KDF_free\fR\|(3). .PP \&\fBEVP_KDF_up_ref()\fR increments the reference count of an already fetched -\&\s-1KDF.\s0 +KDF. .PP \&\fBEVP_KDF_free()\fR frees a fetched algorithm. -\&\s-1NULL\s0 is a valid parameter, for which this function is a no-op. +NULL is a valid parameter, for which this function is a no-op. .SS "Context manipulation functions" .IX Subsection "Context manipulation functions" -\&\fBEVP_KDF_CTX_new()\fR creates a new context for the \s-1KDF\s0 implementation \fIkdf\fR. +\&\fBEVP_KDF_CTX_new()\fR creates a new context for the KDF implementation \fIkdf\fR. .PP -\&\fBEVP_KDF_CTX_free()\fR frees up the context \fIctx\fR. If \fIctx\fR is \s-1NULL,\s0 nothing +\&\fBEVP_KDF_CTX_free()\fR frees up the context \fIctx\fR. If \fIctx\fR is NULL, nothing is done. .PP -\&\fBEVP_KDF_CTX_kdf()\fR returns the \fB\s-1EVP_KDF\s0\fR associated with the context +\&\fBEVP_KDF_CTX_kdf()\fR returns the \fBEVP_KDF\fR associated with the context \&\fIctx\fR. .SS "Computing functions" .IX Subsection "Computing functions" @@ -262,19 +186,19 @@ simply ignored. Also, what happens when a needed parameter isn't passed down is defined by the implementation. .PP -\&\fBEVP_KDF_gettable_params()\fR returns an \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes +\&\fBEVP_KDF_gettable_params()\fR returns an \fBOSSL_PARAM\fR\|(3) array that describes the retrievable and settable parameters. \fBEVP_KDF_gettable_params()\fR returns parameters that can be used with \fBEVP_KDF_get_params()\fR. .PP \&\fBEVP_KDF_gettable_ctx_params()\fR and \fBEVP_KDF_CTX_gettable_params()\fR -return constant \s-1\fBOSSL_PARAM\s0\fR\|(3) arrays that describe the retrievable +return constant \fBOSSL_PARAM\fR\|(3) arrays that describe the retrievable parameters that can be used with \fBEVP_KDF_CTX_get_params()\fR. \&\fBEVP_KDF_gettable_ctx_params()\fR returns the parameters that can be retrieved from the algorithm, whereas \fBEVP_KDF_CTX_gettable_params()\fR returns the parameters that can be retrieved in the context's current state. .PP \&\fBEVP_KDF_settable_ctx_params()\fR and \fBEVP_KDF_CTX_settable_params()\fR return -constant \s-1\fBOSSL_PARAM\s0\fR\|(3) arrays that describe the settable parameters that +constant \fBOSSL_PARAM\fR\|(3) arrays that describe the settable parameters that can be used with \fBEVP_KDF_CTX_set_params()\fR. \fBEVP_KDF_settable_ctx_params()\fR returns the parameters that can be retrieved from the algorithm, whereas \fBEVP_KDF_CTX_settable_params()\fR returns the parameters that can @@ -282,7 +206,7 @@ be retrieved in the context's current state. .SS "Information functions" .IX Subsection "Information functions" \&\fBEVP_KDF_CTX_get_kdf_size()\fR returns the output size if the algorithm produces a fixed amount -of output and \fB\s-1SIZE_MAX\s0\fR otherwise. If an error occurs then 0 is returned. +of output and \fBSIZE_MAX\fR 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. .PP @@ -292,12 +216,12 @@ algorithm that's identifiable with \fIname\fR, otherwise 0. \&\fBEVP_KDF_get0_provider()\fR returns the provider that holds the implementation of the given \fIkdf\fR. .PP -\&\fBEVP_KDF_do_all_provided()\fR traverses all \s-1KDF\s0 implemented by all activated +\&\fBEVP_KDF_do_all_provided()\fR traverses all KDF implemented by all activated providers in the given library context \fIlibctx\fR, and for each of the implementations, calls the given function \fIfn\fR with the implementation method and the given \fIarg\fR as argument. .PP -\&\fBEVP_KDF_get0_name()\fR return the name of the given \s-1KDF.\s0 For fetched KDFs +\&\fBEVP_KDF_get0_name()\fR return the name of the given KDF. For fetched KDFs with multiple names, only one of them is returned; it's recommended to use \fBEVP_KDF_names_do_all()\fR instead. .PP @@ -307,44 +231,37 @@ recommended to use \fBEVP_KDF_names_do_all()\fR instead. \&\fBEVP_KDF_get0_description()\fR returns a description of the \fIkdf\fR, meant for display and human consumption. The description is at the discretion of the \fIkdf\fR implementation. -.SH "PARAMETERS" +.SH PARAMETERS .IX Header "PARAMETERS" The standard parameter names are: -.ie n .IP """pass"" (\fB\s-1OSSL_KDF_PARAM_PASSWORD\s0\fR) <octet string>" 4 -.el .IP "``pass'' (\fB\s-1OSSL_KDF_PARAM_PASSWORD\s0\fR) <octet string>" 4 -.IX Item "pass (OSSL_KDF_PARAM_PASSWORD) <octet string>" -Some \s-1KDF\s0 implementations require a password. -For those \s-1KDF\s0 implementations that support it, this parameter sets the password. -.ie n .IP """salt"" (\fB\s-1OSSL_KDF_PARAM_SALT\s0\fR) <octet string>" 4 -.el .IP "``salt'' (\fB\s-1OSSL_KDF_PARAM_SALT\s0\fR) <octet string>" 4 -.IX Item "salt (OSSL_KDF_PARAM_SALT) <octet string>" -Some \s-1KDF\s0 implementations can take a non-secret unique cryptographic salt. -For those \s-1KDF\s0 implementations that support it, this parameter sets the salt. +.IP """pass"" (\fBOSSL_KDF_PARAM_PASSWORD\fR) <octet string>" 4 +.IX Item """pass"" (OSSL_KDF_PARAM_PASSWORD) <octet string>" +Some KDF implementations require a password. +For those KDF implementations that support it, this parameter sets the password. +.IP """salt"" (\fBOSSL_KDF_PARAM_SALT\fR) <octet string>" 4 +.IX Item """salt"" (OSSL_KDF_PARAM_SALT) <octet string>" +Some KDF implementations can take a non-secret unique cryptographic salt. +For those KDF implementations that support it, this parameter sets the salt. .Sp The default value, if any, is implementation dependent. -.ie n .IP """iter"" (\fB\s-1OSSL_KDF_PARAM_ITER\s0\fR) <unsigned integer>" 4 -.el .IP "``iter'' (\fB\s-1OSSL_KDF_PARAM_ITER\s0\fR) <unsigned integer>" 4 -.IX Item "iter (OSSL_KDF_PARAM_ITER) <unsigned integer>" -Some \s-1KDF\s0 implementations require an iteration count. -For those \s-1KDF\s0 implementations that support it, this parameter sets the +.IP """iter"" (\fBOSSL_KDF_PARAM_ITER\fR) <unsigned integer>" 4 +.IX Item """iter"" (OSSL_KDF_PARAM_ITER) <unsigned integer>" +Some KDF implementations require an iteration count. +For those KDF implementations that support it, this parameter sets the iteration count. .Sp The default value, if any, is implementation dependent. -.ie n .IP """properties"" (\fB\s-1OSSL_KDF_PARAM_PROPERTIES\s0\fR) <\s-1UTF8\s0 string>" 4 -.el .IP "``properties'' (\fB\s-1OSSL_KDF_PARAM_PROPERTIES\s0\fR) <\s-1UTF8\s0 string>" 4 -.IX Item "properties (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" +.IP """properties"" (\fBOSSL_KDF_PARAM_PROPERTIES\fR) <UTF8 string>" 4 +.IX Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" .PD 0 -.ie n .IP """mac"" (\fB\s-1OSSL_KDF_PARAM_MAC\s0\fR) <\s-1UTF8\s0 string>" 4 -.el .IP "``mac'' (\fB\s-1OSSL_KDF_PARAM_MAC\s0\fR) <\s-1UTF8\s0 string>" 4 -.IX Item "mac (OSSL_KDF_PARAM_MAC) <UTF8 string>" -.ie n .IP """digest"" (\fB\s-1OSSL_KDF_PARAM_DIGEST\s0\fR) <\s-1UTF8\s0 string>" 4 -.el .IP "``digest'' (\fB\s-1OSSL_KDF_PARAM_DIGEST\s0\fR) <\s-1UTF8\s0 string>" 4 -.IX Item "digest (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" -.ie n .IP """cipher"" (\fB\s-1OSSL_KDF_PARAM_CIPHER\s0\fR) <\s-1UTF8\s0 string>" 4 -.el .IP "``cipher'' (\fB\s-1OSSL_KDF_PARAM_CIPHER\s0\fR) <\s-1UTF8\s0 string>" 4 -.IX Item "cipher (OSSL_KDF_PARAM_CIPHER) <UTF8 string>" +.IP """mac"" (\fBOSSL_KDF_PARAM_MAC\fR) <UTF8 string>" 4 +.IX Item """mac"" (OSSL_KDF_PARAM_MAC) <UTF8 string>" +.IP """digest"" (\fBOSSL_KDF_PARAM_DIGEST\fR) <UTF8 string>" 4 +.IX Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" +.IP """cipher"" (\fBOSSL_KDF_PARAM_CIPHER\fR) <UTF8 string>" 4 +.IX Item """cipher"" (OSSL_KDF_PARAM_CIPHER) <UTF8 string>" .PD -For \s-1KDF\s0 implementations that use an underlying computation \s-1MAC,\s0 digest or +For KDF implementations that use an underlying computation MAC, digest or cipher, these parameters set what the algorithm should be. .Sp The value is always the name of the intended algorithm, @@ -352,36 +269,32 @@ or the properties. .Sp Note that not all algorithms may support all possible underlying implementations. -.ie n .IP """key"" (\fB\s-1OSSL_KDF_PARAM_KEY\s0\fR) <octet string>" 4 -.el .IP "``key'' (\fB\s-1OSSL_KDF_PARAM_KEY\s0\fR) <octet string>" 4 -.IX Item "key (OSSL_KDF_PARAM_KEY) <octet string>" -Some \s-1KDF\s0 implementations require a key. -For those \s-1KDF\s0 implementations that support it, this octet string parameter +.IP """key"" (\fBOSSL_KDF_PARAM_KEY\fR) <octet string>" 4 +.IX Item """key"" (OSSL_KDF_PARAM_KEY) <octet string>" +Some KDF implementations require a key. +For those KDF implementations that support it, this octet string parameter sets the key. -.ie n .IP """info"" (\fB\s-1OSSL_KDF_PARAM_INFO\s0\fR) <octet string>" 4 -.el .IP "``info'' (\fB\s-1OSSL_KDF_PARAM_INFO\s0\fR) <octet string>" 4 -.IX Item "info (OSSL_KDF_PARAM_INFO) <octet string>" -Some \s-1KDF\s0 implementations, such as \s-1\fBEVP_KDF\-HKDF\s0\fR\|(7), take an 'info' parameter +.IP """info"" (\fBOSSL_KDF_PARAM_INFO\fR) <octet string>" 4 +.IX Item """info"" (OSSL_KDF_PARAM_INFO) <octet string>" +Some KDF implementations, such as \fBEVP_KDF\-HKDF\fR\|(7), take an 'info' parameter for binding the derived key material to application\- and context-specific information. This parameter sets the info, fixed info, other info or shared info argument. You can specify this parameter multiple times, and each instance will be concatenated to form the final value. -.ie n .IP """maclen"" (\fB\s-1OSSL_KDF_PARAM_MAC_SIZE\s0\fR) <unsigned integer>" 4 -.el .IP "``maclen'' (\fB\s-1OSSL_KDF_PARAM_MAC_SIZE\s0\fR) <unsigned integer>" 4 -.IX Item "maclen (OSSL_KDF_PARAM_MAC_SIZE) <unsigned integer>" -Used by implementations that use a \s-1MAC\s0 with a variable output size (\s-1KMAC\s0). -For those \s-1KDF\s0 implementations that support it, this parameter -sets the \s-1MAC\s0 output size. +.IP """maclen"" (\fBOSSL_KDF_PARAM_MAC_SIZE\fR) <unsigned integer>" 4 +.IX Item """maclen"" (OSSL_KDF_PARAM_MAC_SIZE) <unsigned integer>" +Used by implementations that use a MAC with a variable output size (KMAC). +For those KDF implementations that support it, this parameter +sets the MAC output size. .Sp The default value, if any, is implementation dependent. The length must never exceed what can be given with a \fBsize_t\fR. -.ie n .IP """maxmem_bytes"" (\fB\s-1OSSL_KDF_PARAM_SCRYPT_MAXMEM\s0\fR) <unsigned integer>" 4 -.el .IP "``maxmem_bytes'' (\fB\s-1OSSL_KDF_PARAM_SCRYPT_MAXMEM\s0\fR) <unsigned integer>" 4 -.IX Item "maxmem_bytes (OSSL_KDF_PARAM_SCRYPT_MAXMEM) <unsigned integer>" -Memory-hard password-based \s-1KDF\s0 algorithms, such as scrypt, use an amount of +.IP """maxmem_bytes"" (\fBOSSL_KDF_PARAM_SCRYPT_MAXMEM\fR) <unsigned integer>" 4 +.IX Item """maxmem_bytes"" (OSSL_KDF_PARAM_SCRYPT_MAXMEM) <unsigned integer>" +Memory-hard password-based KDF algorithms, such as scrypt, use an amount of memory that depends on the load factors provided as input. -For those \s-1KDF\s0 implementations that support it, this \fBuint64_t\fR parameter sets +For those KDF implementations that support it, this \fBuint64_t\fR parameter sets an upper limit on the amount of memory that may be consumed while performing a key derivation. If this memory usage limit is exceeded because the load factors are chosen @@ -391,47 +304,45 @@ The default value is implementation dependent. The memory size must never exceed what can be given with a \fBsize_t\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBEVP_KDF_fetch()\fR returns a pointer to a newly fetched \fB\s-1EVP_KDF\s0\fR, or -\&\s-1NULL\s0 if allocation failed. +\&\fBEVP_KDF_fetch()\fR returns a pointer to a newly fetched \fBEVP_KDF\fR, or +NULL if allocation failed. .PP -\&\fBEVP_KDF_get0_provider()\fR returns a pointer to the provider for the \s-1KDF,\s0 or -\&\s-1NULL\s0 on error. +\&\fBEVP_KDF_get0_provider()\fR returns a pointer to the provider for the KDF, or +NULL on error. .PP \&\fBEVP_KDF_up_ref()\fR returns 1 on success, 0 on error. .PP \&\fBEVP_KDF_CTX_new()\fR returns either the newly allocated -\&\fB\s-1EVP_KDF_CTX\s0\fR structure or \s-1NULL\s0 if an error occurred. +\&\fBEVP_KDF_CTX\fR structure or NULL if an error occurred. .PP \&\fBEVP_KDF_CTX_free()\fR and \fBEVP_KDF_CTX_reset()\fR do not return a value. .PP -\&\fBEVP_KDF_CTX_get_kdf_size()\fR returns the output size. \fB\s-1SIZE_MAX\s0\fR is returned to indicate +\&\fBEVP_KDF_CTX_get_kdf_size()\fR returns the output size. \fBSIZE_MAX\fR is returned to indicate that the algorithm produces a variable amount of output; 0 to indicate failure. .PP -\&\fBEVP_KDF_get0_name()\fR returns the name of the \s-1KDF,\s0 or \s-1NULL\s0 on error. +\&\fBEVP_KDF_get0_name()\fR returns the name of the KDF, or NULL on error. .PP \&\fBEVP_KDF_names_do_all()\fR returns 1 if the callback was called for all names. A return value of 0 means that the callback was not called for any names. .PP -The remaining functions return 1 for success and 0 or a negative value for -failure. In particular, a return value of \-2 indicates the operation is not -supported by the \s-1KDF\s0 algorithm. -.SH "NOTES" +The remaining functions return 1 for success and 0 for failure. +.SH NOTES .IX Header "NOTES" -The \s-1KDF\s0 life-cycle is described in \fBlife_cycle\-kdf\fR\|(7). In the future, +The KDF life-cycle is described in \fBlife_cycle\-kdf\fR\|(7). In the future, the transitions described there will be enforced. When this is done, it will -not be considered a breaking change to the \s-1API.\s0 +not be considered a breaking change to the API. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\*(L"Key Derivation Function (\s-1KDF\s0)\*(R" in \fBOSSL_PROVIDER\-default\fR\|(7), +"Key Derivation Function (KDF)" in \fBOSSL_PROVIDER\-default\fR\|(7), \&\fBlife_cycle\-kdf\fR\|(7). -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" This functionality was added in OpenSSL 3.0. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2019\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +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 \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |