From 77039e648c8a62bfc4f0242531d5fd4874b29aad Mon Sep 17 00:00:00 2001
From: Guilherme Andrade <g@gandrade.net>
Date: Sat, 18 Mar 2017 17:27:35 +0000
Subject: Support cryptographically strong rand plugin

---
 lib/crypto/doc/src/crypto.xml | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'lib/crypto/doc/src/crypto.xml')

diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index dc725a41be..7a5bd62c26 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -766,6 +766,35 @@
       </desc>
     </func>
 
+    <func>
+      <name>rand_seed() -> rand:state()</name>
+      <fsummary>Strong random number generation plugin state</fsummary>>
+      <desc>
+        Creates state object for <seealso marker="stdlib:rand">random number generation</seealso>,
+        in order to generate cryptographically strong random numbers
+        (based on OpenSSL's <c>BN_rand_range</c>),
+        and saves it on process dictionary before returning it as well.
+        See also <seealso marker="stdlib:rand#seed-1">rand:seed/1</seealso>
+
+        <p><em>Example</em></p>
+        <pre>
+crypto:rand_seed(),
+_IntegerValue = rand:uniform(42), % [1; 42]
+_FloatValue = rand:uniform().     % [0.0; 1.0]</pre>
+      </desc>
+    </func>
+
+    <func>
+      <name>rand_seed_s() -> rand:state()</name>
+      <fsummary>Strong random number generation plugin state</fsummary>>
+      <desc>
+        Creates state object for <seealso marker="stdlib:rand">random number generation</seealso>,
+        in order to generate cryptographically strongly random numbers
+        (based on OpenSSL's <c>BN_rand_range</c>).
+        See also <seealso marker="stdlib:rand#seed_s-1">rand:seed_s/1</seealso>
+      </desc>
+    </func>
+
     <func>
       <name>stream_init(Type, Key) -> State</name>
       <fsummary></fsummary>
-- 
cgit v1.2.3