From: Matt Caswell Date: Sat, 26 Apr 2014 20:56:36 +0000 (+0100) Subject: Fixed minor errors in docs X-Git-Tag: master-post-reformat~849 X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=commitdiff_plain;h=b5450d63499af10569d5fe2977f70abf5d92bfa9 Fixed minor errors in docs --- diff --git a/doc/crypto/PKCS5_PBKDF2_HMAC.pod b/doc/crypto/PKCS5_PBKDF2_HMAC.pod index f8914db3e2..3431ff0c29 100644 --- a/doc/crypto/PKCS5_PBKDF2_HMAC.pod +++ b/doc/crypto/PKCS5_PBKDF2_HMAC.pod @@ -2,7 +2,7 @@ =head1 NAME -PKCS5_PBKDF2_HMAC - password based derivation routine with salt and iteration count +PKCS5_PBKDF2_HMAC, PKCS5_PBKDF2_HMAC_SHA1 - password based derivation routines with salt and iteration count =head1 SYNOPSIS @@ -13,6 +13,10 @@ PKCS5_PBKDF2_HMAC - password based derivation routine with salt and iteration co const EVP_MD *digest, int keylen, unsigned char *out); +int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen, + const unsigned char *salt, int saltlen, int iter, + int keylen, unsigned char *out); + =head1 DESCRIPTION PKCS5_PBKDF2_HMAC() derives a key from a password using a salt and iteration count @@ -24,14 +28,14 @@ function will calculate the length of B using strlen(). B is the salt used in the derivation of length B. If the B is NULL, then B must be 0. The function will not -attempt to calculate the length of the B because its not assumed to +attempt to calculate the length of the B because it is not assumed to be NULL terminated. B is the iteration count and its value should be greater than or equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any B less than 1 is treated as a single iteration. -B is message digest function used in the derivation. Values include +B is the message digest function used in the derivation. Values include any of the EVP_* message digests. PKCS5_PBKDF2_HMAC_SHA1() calls PKCS5_PBKDF2_HMAC() with EVP_sha1(). @@ -50,7 +54,7 @@ of candidate passwords. =head1 RETURN VALUES -PKCS5_PBKDF2_HMAC() returns 1 on success or 0 on error. +PKCS5_PBKDF2_HMAC() and PBKCS5_PBKDF2_HMAC_SHA1() return 1 on success or 0 on error. =head1 SEE ALSO