heimdal: update to lorikeet-heimdal rev 801

[metze/samba/wip.git] / source / heimdal / lib / hcrypto / pkcs5.c

diff --git a/source/heimdal/lib/hcrypto/pkcs5.c b/source/heimdal/lib/hcrypto/pkcs5.c
index 85b8713cba190fafad33d9b7bf55cf7d5b802bfd..8a8f948abb5abafb504810348d6ca5c716ce12d2 100644 (file)
--- a/source/heimdal/lib/hcrypto/pkcs5.c
+++ b/source/heimdal/lib/hcrypto/pkcs5.c
@@ -35,7 +35,7 @@
 #include <config.h>
 #endif
 
-RCSID("$Id: pkcs5.c 17445 2006-05-05 10:37:46Z lha $");
+RCSID("$Id: pkcs5.c 23059 2008-04-18 13:04:08Z lha $");
 
 #ifdef KRB5
 #include <krb5-types.h>
@@ -49,6 +49,22 @@ RCSID("$Id: pkcs5.c 17445 2006-05-05 10:37:46Z lha $");
 
 #include <roken.h>
 
+/**
+ * As descriped in PKCS5, convert a password, salt, and iteration counter into a crypto key.
+ *
+ * @param password Password.
+ * @param password_len Length of password.
+ * @param salt Salt
+ * @param salt_len Length of salt.
+ * @param iter iteration counter.
+ * @param keylen the output key length.
+ * @param key the output key.
+ *
+ * @return 1 on success, non 1 on failure.
+ *
+ * @ingroup hcrypto_misc
+ */
+
 int
 PKCS5_PBKDF2_HMAC_SHA1(const void * password, size_t password_len,
                       const void * salt, size_t salt_len,