EVP_KDF-PBKDF1.pod 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. =pod
  2. =head1 NAME
  3. EVP_KDF-PBKDF1 - The PBKDF1 EVP_KDF implementation
  4. =head1 DESCRIPTION
  5. Support for computing the B<PBKDF1> password-based KDF through the B<EVP_KDF>
  6. API.
  7. The EVP_KDF-PBKDF1 algorithm implements the PBKDF1 password-based key
  8. derivation function, as described in RFC 8018; it derives a key from a password
  9. using a salt and iteration count.
  10. =head2 Identity
  11. "PBKDF1" is the name for this implementation; it
  12. can be used with the EVP_KDF_fetch() function.
  13. =head2 Supported parameters
  14. The supported parameters are:
  15. =over 4
  16. =item "pass" (B<OSSL_KDF_PARAM_PASSWORD>) <octet string>
  17. =item "salt" (B<OSSL_KDF_PARAM_SALT>) <octet string>
  18. =item "iter" (B<OSSL_KDF_PARAM_ITER>) <unsigned integer>
  19. This parameter has a default value of 0 and should be set.
  20. =item "properties" (B<OSSL_KDF_PARAM_PROPERTIES>) <UTF8 string>
  21. =item "digest" (B<OSSL_KDF_PARAM_DIGEST>) <UTF8 string>
  22. These parameters work as described in L<EVP_KDF(3)/PARAMETERS>.
  23. =back
  24. =head1 NOTES
  25. A typical application of this algorithm is to derive keying material for an
  26. encryption algorithm from a password in the "pass", a salt in "salt",
  27. and an iteration count.
  28. Increasing the "iter" parameter slows down the algorithm which makes it
  29. harder for an attacker to perform a brute force attack using a large number
  30. of candidate passwords.
  31. No assumption is made regarding the given password; it is simply treated as a
  32. byte sequence.
  33. The legacy provider needs to be available in order to access this algorithm.
  34. =head1 CONFORMING TO
  35. RFC 8018
  36. =head1 SEE ALSO
  37. L<EVP_KDF(3)>,
  38. L<EVP_KDF_CTX_new(3)>,
  39. L<EVP_KDF_CTX_free(3)>,
  40. L<EVP_KDF_CTX_set_params(3)>,
  41. L<EVP_KDF_derive(3)>,
  42. L<EVP_KDF(3)/PARAMETERS>,
  43. L<OSSL_PROVIDER-legacy(7)>
  44. =head1 HISTORY
  45. This functionality was added in OpenSSL 3.0.
  46. =head1 COPYRIGHT
  47. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  48. Licensed under the Apache License 2.0 (the "License"). You may not use
  49. this file except in compliance with the License. You can obtain a copy
  50. in the file LICENSE in the source distribution or at
  51. L<https://www.openssl.org/source/license.html>.
  52. =cut