Merge branch 'topic/mm-fixes' of git://208.110.73.182/silc into silc.1.1.branch

[silc.git] / lib / silccrypt / silcrng.h

diff --git a/lib/silccrypt/silcrng.h b/lib/silccrypt/silcrng.h
index 7dbdcbf6a692655716b955db638ccb8893e36823..b4deeb8d2eba4867c3208ba48ac96cab0ecb3f27 100644 (file)
--- a/lib/silccrypt/silcrng.h
+++ b/lib/silccrypt/silcrng.h
@@ -1,10 +1,10 @@
 /*
 
-  silcrng.h 
+  silcrng.h
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2002 Pekka Riikonen
+  Copyright (C) 1997 - 2003 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -39,7 +39,7 @@
 /****s* silccrypt/SilcRNGAPI/SilcRng
  *
  * NAME
- * 
+ *
  *    typedef struct SilcRngStruct *SilcRng;
  *
  * DESCRIPTION
@@ -174,7 +174,8 @@ SilcUInt32 silc_rng_get_rn32(SilcRng rng);
  * DESCRIPTION
  *
  *    Returns random string in HEX form of the length of `len' bytes.
- *    The caller must free returned data buffer.
+ *    The caller must free returned data buffer.  It is guaranteed the
+ *    data string goes not include any zero (0x00) bytes.
  *
  ***/
 unsigned char *silc_rng_get_rn_string(SilcRng rng, SilcUInt32 len);
@@ -187,8 +188,9 @@ unsigned char *silc_rng_get_rn_string(SilcRng rng, SilcUInt32 len);
  *
  * DESCRIPTION
  *
- *    Returns random binary data of the length of `len' bytes.  The 
- *    caller must free returned data buffer.
+ *    Returns random binary data of the length of `len' bytes.  The
+ *    caller must free returned data buffer.  It is guaranteed the data
+ *    buffer does not include any zero (0x00) bytes.
  *
  ***/
 unsigned char *silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len);
@@ -201,7 +203,7 @@ unsigned char *silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len);
  *
  * DESCRIPTION
  *
- *    Add the data buffer indicated by `buffer' of length of `len' bytes 
+ *    Add the data buffer indicated by `buffer' of length of `len' bytes
  *    as noise to the random number generator.  The random number generator
  *    is restirred (reseeded) when this function is called.
  *
@@ -212,7 +214,7 @@ void silc_rng_add_noise(SilcRng rng, unsigned char *buffer, SilcUInt32 len);
  *
  * SYNOPSIS
  *
- *    bool silc_rng_global_init(SilcRng rng);
+ *    SilcBool silc_rng_global_init(SilcRng rng);
  *
  * DESCRIPTION
  *
@@ -232,13 +234,13 @@ void silc_rng_add_noise(SilcRng rng, unsigned char *buffer, SilcUInt32 len);
  *    the RNG as argument.
  *
  ***/
-bool silc_rng_global_init(SilcRng rng);
+SilcBool silc_rng_global_init(SilcRng rng);
 
 /****f* silccrypt/SilcRNGAPI/silc_rng_global_uninit
  *
  * SYNOPSIS
  *
- *    bool silc_rng_global_uninit(void);
+ *    SilcBool silc_rng_global_uninit(void);
  *
  * DESCRIPTION
  *
@@ -246,7 +248,7 @@ bool silc_rng_global_init(SilcRng rng);
  *    be called if silc_rng_global_init was called with non-NULL RNG.
  *
  ***/
-bool silc_rng_global_uninit(void);
+SilcBool silc_rng_global_uninit(void);
 
 /****f* silccrypt/SilcRNGAPI/silc_rng_global_get_byte
  *
@@ -317,7 +319,8 @@ SilcUInt32 silc_rng_global_get_rn32(void);
  * DESCRIPTION
  *
  *    Returns random string in HEX form of the length of `len' bytes.
- *    The caller must free returned data buffer.
+ *    The caller must free returned data buffer.  It is guaranteed the
+ *    data string goes not include any zero (0x00) bytes.
  *
  ***/
 unsigned char *silc_rng_global_get_rn_string(SilcUInt32 len);
@@ -330,8 +333,9 @@ unsigned char *silc_rng_global_get_rn_string(SilcUInt32 len);
  *
  * DESCRIPTION
  *
- *    Returns random binary data of the length of `len' bytes.  The 
- *    caller must free returned data buffer.
+ *    Returns random binary data of the length of `len' bytes.  The
+ *    caller must free returned data buffer.  It is guaranteed the data
+ *    buffer does not include any zero (0x00) bytes.
  *
  ***/
 unsigned char *silc_rng_global_get_rn_data(SilcUInt32 len);
@@ -344,7 +348,7 @@ unsigned char *silc_rng_global_get_rn_data(SilcUInt32 len);
  *
  * DESCRIPTION
  *
- *    Add the data buffer indicated by `buffer' of length of `len' bytes 
+ *    Add the data buffer indicated by `buffer' of length of `len' bytes
  *    as noise to the random number generator.  The random number generator
  *    is restirred (reseeded) when this function is called.
  *