summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@github.com>2022-02-07 19:38:32 -0500
committerEdward Thomson <ethomson@edwardthomson.com>2022-02-08 09:59:03 -0500
commitff21940200b22552138858dd0f455a5cb25f5ed7 (patch)
tree919e1b75ef55764a62384eaef77610f1dec181d6
parenta60c1846d619f57e3aadae05f90640f63c56d321 (diff)
downloadlibgit2-ff21940200b22552138858dd0f455a5cb25f5ed7.tar.gz
rand: introduce git_rand PRNG
Introduce `git_rand`, a PRNG based on xoroshiro256**, a fast, all-purpose pseudo-random number generator: https://prng.di.unimi.it The PRNG will be seeded by the system's entropy store when possible, falling back to current time and system data (pid, uptime, etc). Inspiration for this was taken from libressl, but since our PRNG is not used for cryptographic purposes (and indeed currently only generates a unique temp file name that is written in a protected directory), this should be more than sufficient. Our implementation of xoroshiro256** was taken almost strictly from the original author's sources, but was tested against PractRand to ensure that there were no foolish mistranslations: ``` RNG_test using PractRand version 0.94 RNG = RNG_stdin64, seed = unknown test set = core, folding = standard (64 bit) rng=RNG_stdin64, seed=unknown length= 256 megabytes (2^28 bytes), time= 2.9 seconds no anomalies in 210 test result(s) rng=RNG_stdin64, seed=unknown length= 512 megabytes (2^29 bytes), time= 6.2 seconds no anomalies in 226 test result(s) rng=RNG_stdin64, seed=unknown length= 1 gigabyte (2^30 bytes), time= 12.7 seconds no anomalies in 243 test result(s) rng=RNG_stdin64, seed=unknown length= 2 gigabytes (2^31 bytes), time= 25.4 seconds no anomalies in 261 test result(s) rng=RNG_stdin64, seed=unknown length= 4 gigabytes (2^32 bytes), time= 50.6 seconds no anomalies in 277 test result(s) rng=RNG_stdin64, seed=unknown length= 8 gigabytes (2^33 bytes), time= 104 seconds no anomalies in 294 test result(s) ```
-rw-r--r--src/CMakeLists.txt5
-rw-r--r--src/features.h.in4
-rw-r--r--src/libgit2.c2
-rw-r--r--src/rand.c223
-rw-r--r--src/rand.h16
5 files changed, 250 insertions, 0 deletions
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index e2da4bc90..4b2173745 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -55,6 +55,11 @@ check_prototype_definition(qsort_r
check_function_exists(qsort_s GIT_QSORT_S)
+check_function_exists(getrandom GIT_RAND_GETRANDOM)
+if(NOT GIT_RAND_GETENTROPY)
+ check_function_exists(getentropy GIT_RAND_GETENTROPY)
+endif()
+
# Find required dependencies
if(WIN32)
diff --git a/src/features.h.in b/src/features.h.in
index 81a8ae023..cca17fc6f 100644
--- a/src/features.h.in
+++ b/src/features.h.in
@@ -48,4 +48,8 @@
#cmakedefine GIT_SHA1_OPENSSL 1
#cmakedefine GIT_SHA1_MBEDTLS 1
+#cmakedefine GIT_RAND_WIN32 1
+#cmakedefine GIT_RAND_GETRANDOM 1
+#cmakedefine GIT_RAND_GETENTROPY 1
+
#endif
diff --git a/src/libgit2.c b/src/libgit2.c
index b3a72de18..b17485d7f 100644
--- a/src/libgit2.c
+++ b/src/libgit2.c
@@ -20,6 +20,7 @@
#include "mwindow.h"
#include "object.h"
#include "odb.h"
+#include "rand.h"
#include "refs.h"
#include "runtime.h"
#include "sysdir.h"
@@ -70,6 +71,7 @@ int git_libgit2_init(void)
git_allocator_global_init,
git_threadstate_global_init,
git_threads_global_init,
+ git_rand_global_init,
git_hash_global_init,
git_sysdir_global_init,
git_filter_global_init,
diff --git a/src/rand.c b/src/rand.c
new file mode 100644
index 000000000..b541f000d
--- /dev/null
+++ b/src/rand.c
@@ -0,0 +1,223 @@
+/* Written in 2018 by David Blackman and Sebastiano Vigna (vigna@acm.org)
+
+To the extent possible under law, the author has dedicated all copyright
+and related and neighboring rights to this software to the public domain
+worldwide. This software is distributed without any warranty.
+
+See <http://creativecommons.org/publicdomain/zero/1.0/>. */
+
+#include "common.h"
+#include "rand.h"
+#include "runtime.h"
+
+#if defined(GIT_RAND_GETRANDOM) || defined(GIT_RAND_GETENTROPY)
+# include <sys/random.h>
+#endif
+
+static uint64_t state[4];
+static git_mutex state_lock;
+
+/*
+ * On 32-bit systems, we want to put inputs to the seed in the high
+ * and low parts of the 64-bit seed, so we shift some into place.
+ */
+#ifdef GIT_ARCH_32
+# define SEED_SHIFT 32
+#else
+# define SEED_SHIFT 0
+#endif
+
+#if defined(GIT_WIN32)
+GIT_INLINE(int) getseed(uint64_t *seed)
+{
+ HCRYPTPROV provider;
+ SYSTEMTIME systemtime;
+ FILETIME filetime, idletime, kerneltime, usertime;
+
+ if (CryptAcquireContext(&provider, 0, 0, PROV_RSA_FULL,
+ CRYPT_VERIFYCONTEXT|CRYPT_SILENT)) {
+ BOOL success = CryptGenRandom(provider, sizeof(uint64_t), (void *)seed);
+ CryptReleaseContext(provider, 0);
+
+ if (success)
+ return 0;
+ }
+
+ GetSystemTime(&systemtime);
+ if (!SystemTimeToFileTime(&systemtime, &filetime)) {
+ git_error_set(GIT_ERROR_OS, "could not get time for random seed");
+ return -1;
+ }
+
+ /* Fall-through: generate a seed from the time and system state */
+ *seed = 0;
+ *seed |= ((uint64_t)filetime.dwLowDateTime << 32);
+ *seed |= ((uint64_t)filetime.dwHighDateTime);
+
+ *seed ^= ((uint64_t)GetCurrentProcessId() << 32);
+ *seed ^= ((uint64_t)GetCurrentThreadId());
+
+ GetSystemTimes(&idletime, &kerneltime, &usertime);
+ *seed |= ((uint64_t)idletime.dwLowDateTime);
+ *seed |= ((uint64_t)idletime.dwHighDateTime << 32);
+ *seed |= ((uint64_t)kerneltime.dwLowDateTime << 32);
+ *seed |= ((uint64_t)kerneltime.dwHighDateTime);
+ *seed |= ((uint64_t)usertime.dwLowDateTime);
+ *seed |= ((uint64_t)usertime.dwHighDateTime << 32);
+
+ /* Mix in the addresses of some functions and variables */
+ *seed ^= ((uint64_t)((void *)getseed) << SEED_SHIFT);
+ *seed ^= ((uint64_t)((void *)seed));
+ *seed ^= ((uint64_t)((void *)printf) << SEED_SHIFT);
+ *seed ^= ((uint64_t)((void *)&errno));
+
+ *seed ^= ((uint64_t)git__timer());
+
+ return 0;
+}
+
+#else
+
+GIT_INLINE(int) getseed(uint64_t *seed)
+{
+ struct timeval tv;
+ double loadavg[3];
+ int fd;
+
+# if defined(GIT_RAND_GETENTROPYZ)
+ if (getentropy(seed, sizeof(uint64_t)) == 0)
+ return 0;
+# endif
+
+ /*
+ * Try to read from /dev/urandom; most modern systems will have
+ * this, but we may be chrooted, etc, so it's not a fatal error
+ */
+ if ((fd = open("/dev/urandom", O_RDONLY)) >= 0) {
+ ssize_t ret = read(fd, seed, sizeof(uint64_t));
+ close(fd);
+
+ if (ret == (ssize_t)sizeof(uint64_t))
+ return 0;
+ }
+
+ /* Fall-through: generate a seed from the time and system state */
+ *seed = 0;
+
+ if (gettimeofday(&tv, NULL) < 0) {
+ git_error_set(GIT_ERROR_OS, "could get time for random seed");
+ return -1;
+ }
+
+ *seed |= ((uint64_t)tv.tv_usec << 40);
+ *seed |= ((uint64_t)tv.tv_sec);
+
+ *seed ^= ((uint64_t)getpid() << 32);
+ *seed ^= ((uint64_t)getpgid(0));
+ *seed ^= ((uint64_t)getppid() << 32);
+ *seed ^= ((uint64_t)getsid(0));
+ *seed ^= ((uint64_t)getuid() << 32);
+ *seed ^= ((uint64_t)getgid());
+
+ *seed ^= ((uint64_t)loadavg[0]);
+ *seed ^= ((uint64_t)loadavg[1]);
+ *seed ^= ((uint64_t)loadavg[2]);
+
+ /* Mix in the addresses of some functions and variables */
+ *seed ^= ((uint64_t)((size_t)((void *)getseed)) << SEED_SHIFT);
+ *seed ^= ((uint64_t)((size_t)((void *)seed)));
+ *seed ^= ((uint64_t)((size_t)((void *)printf)) << SEED_SHIFT);
+ *seed ^= ((uint64_t)((size_t)((void *)&errno)));
+
+ *seed ^= ((uint64_t)git__timer());
+
+ return 0;
+}
+#endif
+
+static void git_rand_global_shutdown(void)
+{
+ git_mutex_free(&state_lock);
+}
+
+int git_rand_global_init(void)
+{
+ uint64_t seed;
+
+ if (git_mutex_init(&state_lock) < 0 || getseed(&seed) < 0)
+ return -1;
+
+ git_rand_seed(seed);
+ git_runtime_shutdown_register(git_rand_global_shutdown);
+
+ return 0;
+}
+
+/*
+ * This is splitmix64. xoroshiro256** uses 256 bit seed; this is used
+ * to generate 256 bits of seed from the given 64, per the author's
+ * recommendation.
+ */
+GIT_INLINE(uint64_t) splitmix64(uint64_t *in)
+{
+ uint64_t z;
+
+ *in += 0x9e3779b97f4a7c15;
+
+ z = *in;
+ z = (z ^ (z >> 30)) * 0xbf58476d1ce4e5b9;
+ z = (z ^ (z >> 27)) * 0x94d049bb133111eb;
+ return z ^ (z >> 31);
+}
+
+void git_rand_seed(uint64_t seed)
+{
+ uint64_t mixer;
+
+ mixer = seed;
+
+ git_mutex_lock(&state_lock);
+ state[0] = splitmix64(&mixer);
+ state[1] = splitmix64(&mixer);
+ state[2] = splitmix64(&mixer);
+ state[3] = splitmix64(&mixer);
+ git_mutex_unlock(&state_lock);
+}
+
+/* This is xoshiro256** 1.0, one of our all-purpose, rock-solid
+ generators. It has excellent (sub-ns) speed, a state (256 bits) that is
+ large enough for any parallel application, and it passes all tests we
+ are aware of.
+
+ For generating just floating-point numbers, xoshiro256+ is even faster.
+
+ The state must be seeded so that it is not everywhere zero. If you have
+ a 64-bit seed, we suggest to seed a splitmix64 generator and use its
+ output to fill s. */
+
+GIT_INLINE(uint64_t) rotl(const uint64_t x, int k) {
+ return (x << k) | (x >> (64 - k));
+}
+
+uint64_t git_rand_next(void) {
+ uint64_t t, result;
+
+ git_mutex_lock(&state_lock);
+
+ result = rotl(state[1] * 5, 7) * 9;
+
+ t = state[1] << 17;
+
+ state[2] ^= state[0];
+ state[3] ^= state[1];
+ state[1] ^= state[2];
+ state[0] ^= state[3];
+
+ state[2] ^= t;
+
+ state[3] = rotl(state[3], 45);
+
+ git_mutex_unlock(&state_lock);
+
+ return result;
+}
diff --git a/src/rand.h b/src/rand.h
new file mode 100644
index 000000000..3a2edb637
--- /dev/null
+++ b/src/rand.h
@@ -0,0 +1,16 @@
+/*
+ * Copyright (C) the libgit2 contributors. All rights reserved.
+ *
+ * This file is part of libgit2, distributed under the GNU GPL v2 with
+ * a Linking Exception. For full terms see the included COPYING file.
+ */
+#ifndef INCLUDE_rand_h__
+#define INCLUDE_rand_h__
+
+#include "common.h"
+
+int git_rand_global_init(void);
+void git_rand_seed(uint64_t seed);
+uint64_t git_rand_next(void);
+
+#endif