diff options
author | Pauli <pauli@openssl.org> | 2021-07-01 14:40:27 +1000 |
---|---|---|
committer | Pauli <pauli@openssl.org> | 2021-09-28 18:08:41 +1000 |
commit | fc9eda53bcf7d41c8159b7161c663db86dda5481 (patch) | |
tree | 50159104ab63353cb13564e66440228569a64f2b /doc | |
parent | 1ffac6ca174d25a61f2e1e70dd0fd1eb7eaacbf5 (diff) |
doc: add page for PVK KDF
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15968)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man7/EVP_KDF-PVKKDF.pod | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/man7/EVP_KDF-PVKKDF.pod b/doc/man7/EVP_KDF-PVKKDF.pod new file mode 100644 index 0000000000..0d864d7169 --- /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 |