xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_KDF-PVKKDF.7 (revision 4757b351ea9d59d71d4a38b82506d2d16fcd560d)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

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-PVKKDF 7ossl"
EVP_KDF-PVKKDF 7ossl 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.
NAME
EVP_KDF-PVKKDF - The PVK EVP_KDF implementation
DESCRIPTION
Header "DESCRIPTION" Support for computing the PVK KDF PIN-based KDF through the EVP_KDF API.

The EVP_KDF-PVKKDF algorithm implements a PVK PIN-based key derivation function; it derives a key from a password using a salt.

Identity
Subsection "Identity" "PVKKDF" 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:
"""pass"" (OSSL_KDF_PARAM_PASSWORD) <octet string>" 4
Item """pass"" (OSSL_KDF_PARAM_PASSWORD) <octet string>"

0

"""salt"" (OSSL_KDF_PARAM_SALT) <octet string>" 4
Item """salt"" (OSSL_KDF_PARAM_SALT) <octet string>"
"""properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" 4
Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>"
"""digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" 4
Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>"

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

NOTES
Header "NOTES" A typical application of this algorithm is to derive keying material for an encryption algorithm from a password in the "pass" and a salt in "salt".

No assumption is made regarding the given password; it is simply treated as a byte sequence.

The legacy provider needs to be available in order to access this algorithm.

"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_derive\|(3), "PARAMETERS" in EVP_KDF\|(3), \fBOSSL_PROVIDER-legacy\|(7)
HISTORY
Header "HISTORY" This functionality was added in OpenSSL 3.2.
COPYRIGHT
Header "COPYRIGHT" Copyright 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>.