-fix time assertion introduce in last patch
[oweals/gnunet.git] / src / util / crypto_random.c
index 6840445d19f7d51846421add1325a8ce178059fb..1b3367d5860e75a74a19480cd363487003274737 100644 (file)
@@ -1,6 +1,6 @@
 /*
-     This file is part of GNUnet.
-     (C) 2001-2013 Christian Grothoff (and other contributing authors)
+     This file is part of GNUnet.  (C) 2001-2014 Christian Grothoff
+     (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -84,7 +84,7 @@ get_weak_random ()
 
 
 /**
- * Seed a weak random generator. Only GNUNET_CRYPTO_QUALITY_WEAK-mode generator
+ * Seed a weak random generator. Only #GNUNET_CRYPTO_QUALITY_WEAK-mode generator
  * can be seeded.
  *
  * @param seed the seed to use
@@ -138,14 +138,15 @@ GNUNET_CRYPTO_random_block (enum GNUNET_CRYPTO_Quality mode, void *buffer, size_
 
 
 /**
- * Produce a random value.
+ * Produce a random unsigned 32-bit number modulo @a i.
  *
  * @param mode desired quality of the random number
  * @param i the upper limit (exclusive) for the random number
  * @return a random value in the interval [0,i[.
  */
 uint32_t
-GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i)
+GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode,
+                         uint32_t i)
 {
 #ifdef gcry_fast_random_poll
   static unsigned int invokeCount;
@@ -194,13 +195,14 @@ GNUNET_CRYPTO_random_u32 (enum GNUNET_CRYPTO_Quality mode, uint32_t i)
 /**
  * Get an array with a random permutation of the
  * numbers 0...n-1.
- * @param mode GNUNET_RANDOM_QUALITY_STRONG if the strong (but expensive)
- *        PRNG should be used, GNUNET_RANDOM_QUALITY_WEAK otherwise
+ * @param mode #GNUNET_RANDOM_QUALITY_STRONG if the strong (but expensive)
+ *        PRNG should be used, #GNUNET_RANDOM_QUALITY_WEAK otherwise
  * @param n the size of the array
  * @return the permutation array (allocated from heap)
  */
 unsigned int *
-GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n)
+GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode,
+                             unsigned int n)
 {
   unsigned int *ret;
   unsigned int i;
@@ -223,8 +225,7 @@ GNUNET_CRYPTO_random_permute (enum GNUNET_CRYPTO_Quality mode, unsigned int n)
 
 
 /**
- * Random on unsigned 64-bit values.
- *
+ * Generate random unsigned 64-bit value.
  *
  * @param mode desired quality of the random number
  * @param max value returned will be in range [0,max) (exclusive)
@@ -269,6 +270,9 @@ GNUNET_CRYPTO_random_u64 (enum GNUNET_CRYPTO_Quality mode, uint64_t max)
 }
 
 
+/**
+ * Initialize libgcrypt.
+ */
 void __attribute__ ((constructor))
 GNUNET_CRYPTO_random_init ()
 {
@@ -286,12 +290,12 @@ GNUNET_CRYPTO_random_init ()
              "Failed to set libgcrypt option %s: %s\n",
              "DISABLE_SECMEM",
             gcry_strerror (rc));
-  /* we only generate ephemeral keys in-process; for those,
+  /* Otherwise gnunet-ecc takes forever to complete, besides
      we are fine with "just" using GCRY_STRONG_RANDOM */
   if ((rc = gcry_control (GCRYCTL_ENABLE_QUICK_RANDOM, 0)))
     FPRINTF (stderr,
-             "Failed to set libgcrypt option %s: %s\n",
-             "ENABLE_QUICK_RANDOM",
+            "Failed to set libgcrypt option %s: %s\n",
+            "ENABLE_QUICK_RANDOM",
             gcry_strerror (rc));
   gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
   gcry_fast_random_poll ();
@@ -301,11 +305,16 @@ GNUNET_CRYPTO_random_init ()
 }
 
 
+/**
+ * Nicely shut down libgcrypt.
+ */
 void __attribute__ ((destructor))
 GNUNET_CRYPTO_random_fini ()
 {
   gcry_set_progress_handler (NULL, NULL);
+#ifdef GCRYCTL_CLOSE_RANDOM_DEVICE
   (void) gcry_control (GCRYCTL_CLOSE_RANDOM_DEVICE, 0);
+#endif
 }