mirror of
https://github.com/openssl/openssl.git
synced 2024-12-21 06:09:35 +08:00
4741c80c05
Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/19690)
157 lines
4.9 KiB
Plaintext
157 lines
4.9 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_KDF-HKDF - The HKDF EVP_KDF implementation
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Support for computing the B<HKDF> KDF through the B<EVP_KDF> API.
|
|
|
|
The EVP_KDF-HKDF algorithm implements the HKDF key derivation function.
|
|
HKDF follows the "extract-then-expand" paradigm, where the KDF logically
|
|
consists of two modules. The first stage takes the input keying material
|
|
and "extracts" from it a fixed-length pseudorandom key K. The second stage
|
|
"expands" the key K into several additional pseudorandom keys (the output
|
|
of the KDF).
|
|
|
|
=head2 Identity
|
|
|
|
"HKDF" is the name for this implementation; it
|
|
can be used with the EVP_KDF_fetch() function.
|
|
|
|
=head2 Supported parameters
|
|
|
|
The supported parameters are:
|
|
|
|
=over 4
|
|
|
|
=item "properties" (B<OSSL_KDF_PARAM_PROPERTIES>) <UTF8 string>
|
|
|
|
=item "digest" (B<OSSL_KDF_PARAM_DIGEST>) <UTF8 string>
|
|
|
|
=item "key" (B<OSSL_KDF_PARAM_KEY>) <octet string>
|
|
|
|
=item "salt" (B<OSSL_KDF_PARAM_SALT>) <octet string>
|
|
|
|
These parameters work as described in L<EVP_KDF(3)/PARAMETERS>.
|
|
|
|
=item "info" (B<OSSL_KDF_PARAM_INFO>) <octet string>
|
|
|
|
This parameter sets the info value.
|
|
The length of the context info buffer cannot exceed 1024 bytes;
|
|
this should be more than enough for any normal use of HKDF.
|
|
|
|
=item "mode" (B<OSSL_KDF_PARAM_MODE>) <UTF8 string> or <integer>
|
|
|
|
This parameter sets the mode for the HKDF operation.
|
|
There are three modes that are currently defined:
|
|
|
|
=over 4
|
|
|
|
=item "EXTRACT_AND_EXPAND" or B<EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND>
|
|
|
|
This is the default mode. Calling L<EVP_KDF_derive(3)> on an EVP_KDF_CTX set
|
|
up for HKDF will perform an extract followed by an expand operation in one go.
|
|
The derived key returned will be the result after the expand operation. The
|
|
intermediate fixed-length pseudorandom key K is not returned.
|
|
|
|
In this mode the digest, key, salt and info values must be set before a key is
|
|
derived otherwise an error will occur.
|
|
|
|
=item "EXTRACT_ONLY" or B<EVP_KDF_HKDF_MODE_EXTRACT_ONLY>
|
|
|
|
In this mode calling L<EVP_KDF_derive(3)> will just perform the extract
|
|
operation. The value returned will be the intermediate fixed-length pseudorandom
|
|
key K. The I<keylen> parameter must match the size of K, which can be looked
|
|
up by calling EVP_KDF_CTX_get_kdf_size() after setting the mode and digest.
|
|
|
|
The digest, key and salt values must be set before a key is derived otherwise
|
|
an error will occur.
|
|
|
|
=item "EXPAND_ONLY" or B<EVP_KDF_HKDF_MODE_EXPAND_ONLY>
|
|
|
|
In this mode calling L<EVP_KDF_derive(3)> will just perform the expand
|
|
operation. The input key should be set to the intermediate fixed-length
|
|
pseudorandom key K returned from a previous extract operation.
|
|
|
|
The digest, key and info values must be set before a key is derived otherwise
|
|
an error will occur.
|
|
|
|
=back
|
|
|
|
=back
|
|
|
|
=head1 NOTES
|
|
|
|
A context for HKDF can be obtained by calling:
|
|
|
|
EVP_KDF *kdf = EVP_KDF_fetch(NULL, "HKDF", NULL);
|
|
EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf);
|
|
|
|
The output length of an HKDF expand operation is specified via the I<keylen>
|
|
parameter to the L<EVP_KDF_derive(3)> function. When using
|
|
EVP_KDF_HKDF_MODE_EXTRACT_ONLY the I<keylen> parameter must equal the size of
|
|
the intermediate fixed-length pseudorandom key otherwise an error will occur.
|
|
For that mode, the fixed output size can be looked up by calling EVP_KDF_CTX_get_kdf_size()
|
|
after setting the mode and digest on the B<EVP_KDF_CTX>.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
This example derives 10 bytes using SHA-256 with the secret key "secret",
|
|
salt value "salt" and info value "label":
|
|
|
|
EVP_KDF *kdf;
|
|
EVP_KDF_CTX *kctx;
|
|
unsigned char out[10];
|
|
OSSL_PARAM params[5], *p = params;
|
|
|
|
kdf = EVP_KDF_fetch(NULL, "HKDF", 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_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);
|
|
|
|
=head1 CONFORMING TO
|
|
|
|
RFC 5869
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<EVP_KDF(3)>,
|
|
L<EVP_KDF_CTX_new(3)>,
|
|
L<EVP_KDF_CTX_free(3)>,
|
|
L<EVP_KDF_CTX_get_kdf_size(3)>,
|
|
L<EVP_KDF_CTX_set_params(3)>,
|
|
L<EVP_KDF_derive(3)>,
|
|
L<EVP_KDF(3)/PARAMETERS>,
|
|
L<EVP_KDF-TLS13_KDF(7)>
|
|
|
|
=head1 HISTORY
|
|
|
|
This functionality was added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2016-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
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|