lib:util: Fix documentation for random number functions
authorAndreas Schneider <asn@samba.org>
Mon, 12 Aug 2019 14:10:20 +0000 (16:10 +0200)
committerAlexander Bokovoy <ab@samba.org>
Wed, 14 Aug 2019 15:07:24 +0000 (15:07 +0000)
Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Alexander Bokovoy <ab@samba.org>
lib/util/genrand.c
lib/util/genrand.h

index a5809aa..18ffa0d 100644 (file)
 
 _PUBLIC_ void generate_random_buffer(uint8_t *out, int len)
 {
-       /* Thread and fork safe random number generator for temporary keys. */
+       /* Random number generator for temporary keys. */
        gnutls_rnd(GNUTLS_RND_RANDOM, out, len);
 }
 
 _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len)
 {
-       /* The key generator, will re-seed after a fixed amount of bytes is
+       /*
+        * Random number generator for long term keys.
+        *
+        * The key generator, will re-seed after a fixed amount of bytes is
         * generated (typically less than the nonce), and will also re-seed
         * based on time, i.e., after few hours of operation without reaching
         * the limit for a re-seed. For its re-seed it mixes mixes data obtained
@@ -51,6 +54,8 @@ _PUBLIC_ void generate_secret_buffer(uint8_t *out, int len)
 _PUBLIC_ void generate_nonce_buffer(uint8_t *out, int len)
 {
        /*
+        * Random number generator for nonce and initialization vectors.
+        *
         * The nonce generator will reseed after outputting a fixed amount of
         * bytes (typically few megabytes), or after few hours of operation
         * without reaching the limit has passed.
index abb8ce2..70f3631 100644 (file)
 */
 
 /**
- * Thread and fork safe random number generator for temporary keys.
+ * @brief Generate random values for session and temporary keys.
+ *
+ * @param[in]  out  A pointer to the buffer to fill with random data.
+ *
+ * @param[in]  len  The size of the buffer to fill.
  */
 void generate_random_buffer(uint8_t *out, int len);
 
 /**
- * @brief Generate random values for key buffers (e.g. session keys)
+ * @brief Generate random values for long term keys and passwords.
  *
  * @param[in]  out  A pointer to the buffer to fill with random data.
  *