doc: add page for PVK KDF

[openssl.git] / doc / man7 / EVP_KDF-PVKKDF.pod

diff --git a/doc/man7/EVP_KDF-PVKKDF.pod b/doc/man7/EVP_KDF-PVKKDF.pod
new file mode 100644 (file)
index 0000000..0d864d7
--- /dev/null
+++ b/doc/man7/EVP_KDF-PVKKDF.pod
@@ -0,0 +1,68 @@
+=pod
+
+=head1 NAME
+
+EVP_KDF-PVKKDF - The PVK EVP_KDF implementation
+
+=head1 DESCRIPTION
+
+Support for computing the B<PVK KDF> PIN-based KDF through the B<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.
+
+=head2 Identity
+
+"PVKKDF" 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 "pass" (B<OSSL_KDF_PARAM_PASSWORD>) <octet string>
+
+=item "salt" (B<OSSL_KDF_PARAM_SALT>) <octet string>
+
+=item "properties" (B<OSSL_KDF_PARAM_PROPERTIES>) <UTF8 string>
+
+=item "digest" (B<OSSL_KDF_PARAM_DIGEST>) <UTF8 string>
+
+These parameters work as described in L<EVP_KDF(3)/PARAMETERS>.
+
+=back
+
+=head1 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.
+
+=head1 SEE ALSO
+
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_derive(3)>,
+L<EVP_KDF(3)/PARAMETERS>
+
+=head1 HISTORY
+
+This functionality was added to OpenSSL 3.0.
+
+=head1 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
+L<https://www.openssl.org/source/license.html>.
+
+=cut