Document the implemented entropy sources

1 files changed, 14 insertions, 0 deletions

diff --git a/doc/manual/rng.rst b/doc/manual/rng.rst
index bc34d75a9..ce44c7d16 100644
--- a/doc/manual/rng.rst
+++ b/doc/manual/rng.rst
@@ -220,6 +220,20 @@ has been hashed by the ``RandomNumberGenerator`` that asked for the
 entropy, thus any hashing you do will be wasteful of both CPU cycles
 and entropy.
 
+The following entropy sources are currently used:
+
+ * System RNG. This is simply however the system RNG is implemented on the
+   current system (arc4random, reading /dev/urandom, or RtlGenRandom).
+ * RDRAND: is used if available, but not counted as contributing entropy
+ * RDSEED: is used if available, but not counted as contributing entropy
+ * Darwin SecRandomCopyBytes. This may be redundant with the system RNG
+ * /dev/random and /dev/urandom. This may be redundant with the system RNG
+ * getentropy, only used on OpenBSD currently
+ * /proc walk: read files in /proc. Last ditch protection against
+   flawed system RNG.
+ * Win32 stats: takes snapshot of current system processes. Last ditch
+   protection against flawed system RNG.
+
 Fork Safety
 ---------------------------------