aboutsummaryrefslogtreecommitdiffstats
path: root/lib/crypto/doc/src/crypto_app.xml
diff options
context:
space:
mode:
authorRaimo Niskanen <[email protected]>2017-10-05 13:33:24 +0200
committerGitHub <[email protected]>2017-10-05 13:33:24 +0200
commitbd09707f2a3fb3a03a406588fe91f9cb8552f75c (patch)
treef022942fa1fe5a2598354e31f0eb5d4ea2874554 /lib/crypto/doc/src/crypto_app.xml
parent558f152750f87f192deb9492a0c21699eee30020 (diff)
parenta89405725c623d489643c2bd4a07ce626dccdcc3 (diff)
downloadotp-bd09707f2a3fb3a03a406588fe91f9cb8552f75c.tar.gz
otp-bd09707f2a3fb3a03a406588fe91f9cb8552f75c.tar.bz2
otp-bd09707f2a3fb3a03a406588fe91f9cb8552f75c.zip
Merge pull request #1573 from RaimoNiskanen/raimo/crypto/rand-cached
Rand plugin for cached strong crypto bytes OTP-13370
Diffstat (limited to 'lib/crypto/doc/src/crypto_app.xml')
-rw-r--r--lib/crypto/doc/src/crypto_app.xml18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/crypto/doc/src/crypto_app.xml b/lib/crypto/doc/src/crypto_app.xml
index ba22557480..8296b1bc77 100644
--- a/lib/crypto/doc/src/crypto_app.xml
+++ b/lib/crypto/doc/src/crypto_app.xml
@@ -68,6 +68,24 @@
thus the crypto module will fail to load. This mechanism
prevents the accidental use of non-validated algorithms.</p>
</item>
+ <tag><c>rand_cache_size = integer()</c></tag>
+ <item>
+ <p>
+ Sets the cache size in bytes to use by
+ <seealso marker="crypto#rand_seed_alg-1">
+ <c>crypto:rand_seed_alg(crypto_cache)</c>
+ </seealso> and
+ <seealso marker="crypto#rand_seed_alg_s-1">
+ <c>crypto:rand_seed_alg_s(crypto_cache)</c>
+ </seealso>.
+ This parameter is read when a seed function is called,
+ and then kept in generators state object. It has a rather
+ small default value that causes reads of strong random bytes
+ about once per hundred calls for a random value.
+ The set value is rounded up to an integral number of words
+ of the size these seed functions use.
+ </p>
+ </item>
</taglist>
</section>