Added silc_rng_get_byte_fast function

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

diff --git a/lib/silccrypt/silcrng.h b/lib/silccrypt/silcrng.h
index 9a173ffb7cc8d7d3de327d46bcdbd6c9a22972ea..7dbdcbf6a692655716b955db638ccb8893e36823 100644 (file)
--- a/lib/silccrypt/silcrng.h
+++ b/lib/silccrypt/silcrng.h
@@ -118,6 +118,27 @@ void silc_rng_init(SilcRng rng);
  ***/
 SilcUInt8 silc_rng_get_byte(SilcRng rng);
 
+/****f* silccrypt/SilcRNGAPI/silc_rng_get_byte_fast
+ *
+ * SYNOPSIS
+ *
+ *    SilcUInt8 silc_rng_get_byte_fast(SilcRng rng);
+ *
+ * DESCRIPTION
+ *
+ *    Returns one 8-bit random byte from the random number generator as
+ *    fast as possible.
+ *
+ * NOTES
+ *
+ *    This will read the data from /dev/urandom if it is available in the
+ *    operating system, since this may be faster than retrieving a byte
+ *    from the SILC RNG.  If /dev/urandom is not available this will take
+ *    the byte from SILC RNG and is effectively same as silc_rng_get_byte.
+ *
+ ***/
+SilcUInt8 silc_rng_get_byte_fast(SilcRng rng);
+
 /****f* silccrypt/SilcRNGAPI/silc_rng_get_rn16
  *
  * SYNOPSIS