Skip to content

Commit

Permalink
Fixed minor errors in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattcaswell committed Apr 26, 2014
1 parent 6bcc447 commit b5450d6
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions doc/crypto/PKCS5_PBKDF2_HMAC.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -24,14 +28,14 @@ function will calculate the length of B<pass> using strlen().

B<salt> is the salt used in the derivation of length B<saltlen>. If the
B<salt> is NULL, then B<saltlen> must be 0. The function will not
attempt to calculate the length of the B<salt> because its not assumed to
attempt to calculate the length of the B<salt> because it is not assumed to
be NULL terminated.

B<iter> 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<iter> less than 1 is treated as a single iteration.

B<digest> is message digest function used in the derivation. Values include
B<digest> 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().

Expand All @@ -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

Expand Down

0 comments on commit b5450d6

Please sign in to comment.