Browse Source

fix some doxygen headers

Steffen Jaeckel 8 years ago
parent
commit
ac6fb72ef1

+ 8 - 2
src/hashes/chc/chc.c

@@ -153,9 +153,15 @@ static int chc_compress(hash_state *md, unsigned char *buf)
    return CRYPT_OK;
 }
 
-/* function for processing blocks */
+/**
+   Function for processing blocks
+   @param md   The hash state
+   @param buf  The data to hash
+   @param len  The length of the data (octets)
+   @return CRYPT_OK if successful
+*/
 static int _chc_process(hash_state * md, const unsigned char *buf, unsigned long len);
-static HASH_PROCESS(_chc_process, chc_compress, chc, (unsigned long)cipher_blocksize)
+HASH_PROCESS(_chc_process, chc_compress, chc, (unsigned long)cipher_blocksize)
 
 /**
    Process a block of memory though the hash

+ 1 - 0
src/hashes/md4.c

@@ -188,6 +188,7 @@ int md4_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int md4_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(md4_process, md4_compress, md4, 64)
 
 /**

+ 1 - 0
src/hashes/md5.c

@@ -247,6 +247,7 @@ int md5_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int md5_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(md5_process, md5_compress, md5, 64)
 
 /**

+ 1 - 0
src/hashes/rmd128.c

@@ -286,6 +286,7 @@ int rmd128_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int rmd128_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(rmd128_process, rmd128_compress, rmd128, 64)
 
 /**

+ 1 - 0
src/hashes/rmd160.c

@@ -345,6 +345,7 @@ int rmd160_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int rmd160_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(rmd160_process, rmd160_compress, rmd160, 64)
 
 /**

+ 1 - 0
src/hashes/rmd256.c

@@ -299,6 +299,7 @@ int rmd256_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int rmd256_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(rmd256_process, rmd256_compress, rmd256, 64)
 
 /**

+ 1 - 0
src/hashes/rmd320.c

@@ -364,6 +364,7 @@ int rmd320_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int rmd320_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(rmd320_process, rmd320_compress, rmd320, 64)
 
 /**

+ 1 - 0
src/hashes/sha1.c

@@ -180,6 +180,7 @@ int sha1_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int sha1_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(sha1_process, sha1_compress, sha1, 64)
 
 /**

+ 1 - 0
src/hashes/sha2/sha256.c

@@ -225,6 +225,7 @@ int sha256_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int sha256_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(sha256_process, sha256_compress, sha256, 64)
 
 /**

+ 1 - 0
src/hashes/sha2/sha512.c

@@ -193,6 +193,7 @@ int sha512_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int sha512_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(sha512_process, sha512_compress, sha512, 128)
 
 /**

+ 1 - 0
src/hashes/tiger.c

@@ -671,6 +671,7 @@ int tiger_init(hash_state *md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int tiger_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(tiger_process, tiger_compress, tiger, 64)
 
 /**

+ 1 - 0
src/hashes/whirl/whirl.c

@@ -138,6 +138,7 @@ int whirlpool_init(hash_state * md)
    @param inlen  The length of the data (octets)
    @return CRYPT_OK if successful
 */
+int whirlpool_process(hash_state * md, const unsigned char *in, unsigned long inlen);
 HASH_PROCESS(whirlpool_process, whirlpool_compress, whirlpool, 64)
 
 /**

+ 13 - 2
src/misc/compare_testvector.c

@@ -10,7 +10,7 @@
 #include "tomcrypt.h"
 
 /**
-  @file compare_testvecotr.c
+  @file compare_testvector.c
   Function to compare two testvectors and print a (detailed) error-message if required, Steffen Jaeckel
 */
 
@@ -49,13 +49,24 @@ static void _print_hex(const char* what, const void* v, const unsigned long l)
 }
 #endif
 
+/**
+  Compare two test-vectors
+
+  @param is             The data as it is
+  @param is_len         The length of is
+  @param should         The data as it should
+  @param should_len     The length of should
+  @param what           The type of the data
+  @param which          The iteration count
+  @return 0 on equality, -1 or 1 on difference
+*/
 int compare_testvector(const void* is, const unsigned long is_len, const void* should, const unsigned long should_len, const char* what, int which)
 {
    int res = 0;
    if(is_len != should_len)
       res = is_len > should_len ? -1 : 1;
    else
-      res = XMEMCMP(is, should, MAX(is_len, should_len));
+      res = XMEMCMP(is, should, is_len);
 
 #if defined(LTC_TEST) && defined(LTC_TEST_DBG)
    if (res != 0) {

+ 2 - 2
src/pk/asn1/der/generalizedtime/der_encode_generalizedtime.c

@@ -32,8 +32,8 @@ static const char * const baseten = "0123456789";
 
 /**
   Encodes a Generalized time structure in DER format
-  @param utctime      The UTC time structure to encode
-  @param out          The destination of the DER encoding of the UTC time structure
+  @param gtime        The GeneralizedTime structure to encode
+  @param out          The destination of the DER encoding of the GeneralizedTime structure
   @param outlen       [in/out] The length of the DER encoding
   @return CRYPT_OK if successful
 */

+ 1 - 1
src/pk/asn1/der/generalizedtime/der_length_generalizedtime.c

@@ -18,7 +18,7 @@
 
 /**
   Gets length of DER encoding of GeneralizedTime
-  @param utctime      The UTC time structure to get the size of
+  @param gtime        The GeneralizedTime structure to get the size of
   @param outlen [out] The length of the DER encoding
   @return CRYPT_OK if successful
 */