Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: EVP_KDF-SS.7,v 1.6 2025/04/16 15:23:15 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 Standard preamble:
 ========================================================================
..

..


..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
 ========================================================================

 Title "EVP_KDF-SS 7" 
 EVP_KDF-SS 7 2025-02-11 3.0.16 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh

 NAME
EVP_KDF-SS - The Single Step / One Step EVP_KDF implementation

 DESCRIPTION
 Header "DESCRIPTION" The EVP_KDF-SS algorithm implements the Single Step key derivation function (SSKDF).
SSKDF derives a key using input such as a shared secret key (that was generated
during the execution of a key establishment scheme) and fixedinfo.
SSKDF is also informally referred to as 'Concat KDF'.


The output is considered to be keying material.

 "Auxiliary function"
 Subsection "Auxiliary function" The implementation uses a selectable auxiliary function H, which can be one of:

 "H(x) = hash(x, digest=md)" 4
 Item "H(x) = hash(x, digest=md)" 
 0

 "H(x) = HMAC_hash(x, key=salt, digest=md)" 4
 Item "H(x) = HMAC_hash(x, key=salt, digest=md)" 
 "H(x) = KMACxxx(x, key=salt, custom=""KDF"", outlen=mac_size)" 4
 Item "H(x) = KMACxxx(x, key=salt, custom=""KDF"", outlen=mac_size)" 



Both the HMAC and KMAC implementations set the key using the 'salt' value.
The hash and HMAC also require the digest to be set.

 Identity
 Subsection "Identity" "SSKDF" is the name for this implementation; it
can be used with the EVP_KDF_fetch() function.

 "Supported parameters"
 Subsection "Supported parameters" The supported parameters are:

 """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" 4
 Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" 
 0

 """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" 4
 Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" 

This parameter is ignored for KMAC.

 """mac"" (OSSL_KDF_PARAM_MAC) <UTF8 string>" 4
 Item """mac"" (OSSL_KDF_PARAM_MAC) <UTF8 string>" 
 0

 """maclen"" (OSSL_KDF_PARAM_MAC_SIZE) <unsigned integer>" 4
 Item """maclen"" (OSSL_KDF_PARAM_MAC_SIZE) <unsigned integer>" 
 """salt"" (OSSL_KDF_PARAM_SALT) <octet string>" 4
 Item """salt"" (OSSL_KDF_PARAM_SALT) <octet string>" 

These parameters work as described in "PARAMETERS" in EVP_KDF\|(3).

 """key"" (OSSL_KDF_PARAM_SECRET) <octet string>" 4
 Item """key"" (OSSL_KDF_PARAM_SECRET) <octet string>" This parameter set the shared secret that is used for key derivation.

 """info"" (OSSL_KDF_PARAM_INFO) <octet string>" 4
 Item """info"" (OSSL_KDF_PARAM_INFO) <octet string>" This parameter sets an optional value for fixedinfo, also known as otherinfo.

 NOTES
 Header "NOTES" A context for SSKDF can be obtained by calling:


.Vb 2
 EVP_KDF *kdf = EVP_KDF_fetch(NULL, "SSKDF", NULL);
 EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf);
.Ve


The output length of an SSKDF is specified via the keylen
parameter to the EVP_KDF_derive\|(3) function.

 EXAMPLES
 Header "EXAMPLES" This example derives 10 bytes using H(x) = SHA-256, with the secret key "secret"
and fixedinfo value "label":


.Vb 4
 EVP_KDF *kdf;
 EVP_KDF_CTX *kctx;
 unsigned char out[10];
 OSSL_PARAM params[4], *p = params;
\&
 kdf = EVP_KDF_fetch(NULL, "SSKDF", NULL);
 kctx = EVP_KDF_CTX_new(kdf);
 EVP_KDF_free(kdf);
\&
 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
  SN_sha256, strlen(SN_sha256));
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
  "secret", (size_t)6);
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
  "label", (size_t)5);
 *p = OSSL_PARAM_construct_end();
 if (EVP_KDF_derive(kctx, out, sizeof(out), params) <= 0) {
  error("EVP_KDF_derive");
 }
\&
 EVP_KDF_CTX_free(kctx);
.Ve


This example derives 10 bytes using H(x) = HMAC(SHA-256), with the secret key "secret",
fixedinfo value "label" and salt "salt":


.Vb 4
 EVP_KDF *kdf;
 EVP_KDF_CTX *kctx;
 unsigned char out[10];
 OSSL_PARAM params[6], *p = params;
\&
 kdf = EVP_KDF_fetch(NULL, "SSKDF", NULL);
 kctx = EVP_KDF_CTX_new(kdf);
 EVP_KDF_free(kdf);
\&
 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_MAC,
  SN_hmac, strlen(SN_hmac));
 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
  SN_sha256, strlen(SN_sha256));
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SECRET,
  "secret", (size_t)6);
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
  "label", (size_t)5);
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
  "salt", (size_t)4);
 *p = OSSL_PARAM_construct_end();
 if (EVP_KDF_derive(kctx, out, sizeof(out), params) <= 0) {
  error("EVP_KDF_derive");
 }
\&
 EVP_KDF_CTX_free(kctx);
.Ve


This example derives 10 bytes using H(x) = KMAC128(x,salt,outlen), with the secret key "secret"
fixedinfo value "label", salt of "salt" and KMAC outlen of 20:


.Vb 4
 EVP_KDF *kdf;
 EVP_KDF_CTX *kctx;
 unsigned char out[10];
 OSSL_PARAM params[6], *p = params;
\&
 kdf = EVP_KDF_fetch(NULL, "SSKDF", NULL);
 kctx = EVP_KDF_CTX_new(kdf);
 EVP_KDF_free(kdf);
\&
 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_MAC,
  SN_kmac128, strlen(SN_kmac128));
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SECRET,
  "secret", (size_t)6);
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
  "label", (size_t)5);
 *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
  "salt", (size_t)4);
 *p++ = OSSL_PARAM_construct_size_t(OSSL_KDF_PARAM_MAC_SIZE, (size_t)20);
 *p = OSSL_PARAM_construct_end();
 if (EVP_KDF_derive(kctx, out, sizeof(out), params) <= 0) {
  error("EVP_KDF_derive");
 }
\&
 EVP_KDF_CTX_free(kctx);
.Ve

 "CONFORMING TO"
 Header "CONFORMING TO" NIST SP800-56Cr1.

 "SEE ALSO"
 Header "SEE ALSO" \fBEVP_KDF\|(3),
\fBEVP_KDF_CTX_new\|(3),
\fBEVP_KDF_CTX_free\|(3),
\fBEVP_KDF_CTX_set_params\|(3),
\fBEVP_KDF_CTX_get_kdf_size\|(3),
\fBEVP_KDF_derive\|(3),
"PARAMETERS" in EVP_KDF\|(3)

 HISTORY
 Header "HISTORY" This functionality was added in OpenSSL 3.0.

 COPYRIGHT
 Header "COPYRIGHT" Copyright 2019-2023 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>.