summaryrefslogtreecommitdiff
path: root/beecrypt/md5.h
diff options
context:
space:
mode:
authorjbj <devnull@localhost>2003-05-16 17:19:42 +0000
committerjbj <devnull@localhost>2003-05-16 17:19:42 +0000
commitcaee135c54ea54149775d61dc49d4bcf58ff2268 (patch)
tree2f96a6504bfa496d16fce9737e4878f08746c756 /beecrypt/md5.h
parent420be4069938be086e69834ee5df914d2eaf21f1 (diff)
downloadlibrpm-tizen-caee135c54ea54149775d61dc49d4bcf58ff2268.tar.gz
librpm-tizen-caee135c54ea54149775d61dc49d4bcf58ff2268.tar.bz2
librpm-tizen-caee135c54ea54149775d61dc49d4bcf58ff2268.zip
Merge to latest beecrypt-3.0.0.
CVS patchset: 6847 CVS date: 2003/05/16 17:19:42
Diffstat (limited to 'beecrypt/md5.h')
-rw-r--r--beecrypt/md5.h20
1 files changed, 18 insertions, 2 deletions
diff --git a/beecrypt/md5.h b/beecrypt/md5.h
index ed6b0ab6b..fd3d00553 100644
--- a/beecrypt/md5.h
+++ b/beecrypt/md5.h
@@ -49,11 +49,14 @@ extern "C" {
#endif
/** \ingroup HASH_md5_m
+ * Holds the full API description of the MD5 algorithm.
*/
/*@observer@*/ /*@checked@*/
extern BEECRYPTAPI const hashFunction md5;
/** \ingroup HASH_md5_m
+ * This function performs the MD5 hash algorithm on 64 byte blocks of data.
+ * @param mp hash parameter block
*/
/*@-exportlocal@*/
BEECRYPTAPI
@@ -62,6 +65,9 @@ void md5Process(md5Param* mp)
/*@=exportlocal@*/
/** \ingroup HASH_md5_m
+ * This function resets the parameter block so that it's ready for a new hash.
+ * @param mp hash parameter block
+ * @return 0 on success.
*/
/*@-exportlocal@*/
BEECRYPTAPI
@@ -70,6 +76,11 @@ int md5Reset (md5Param* mp)
/*@=exportlocal@*/
/** \ingroup HASH_md5_m
+ * This function should be used to pass successive blocks of data to be hashed.
+ * @param mp hash parameter block
+ * @param *data bytes to hash
+ * @param size no. of bytes to hash
+ * @return 0 on success
*/
/*@-exportlocal@*/
BEECRYPTAPI
@@ -78,11 +89,16 @@ int md5Update (md5Param* mp, const byte* data, size_t size)
/*@=exportlocal@*/
/** \ingroup HASH_md5_m
+ * This function finishes the current hash computation, returning the digest
+ * value in \a digest.
+ * @param sp hash parameter block
+ * @retval *digest 16 byte MD5 digest
+ * @return 0 on success.
*/
/*@-exportlocal@*/
BEECRYPTAPI
-int md5Digest (md5Param* mp, /*@out@*/ byte* data)
- /*@modifies mp, data @*/;
+int md5Digest (md5Param* mp, /*@out@*/ byte* digest)
+ /*@modifies mp, digest @*/;
/*@=exportlocal@*/
#ifdef __cplusplus