[sr-dev] git:5.3:3c11a405: tls: docs for rand_engine parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 5.3
Commit: 3c11a405344af55aa4b9c8d35e1c181473cbdf42
URL: https://github.com/kamailio/kamailio/commit/3c11a405344af55aa4b9c8d35e1c181473cbdf42

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-10-07T10:52:03+02:00

tls: docs for rand_engine parameter

(cherry picked from commit 787b95a5a0573d4e81b2475a84bad59076e34faf)

---

Modified: src/modules/tls/doc/params.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/3c11a405344af55aa4b9c8d35e1c181473cbdf42.diff
Patch: https://github.com/kamailio/kamailio/commit/3c11a405344af55aa4b9c8d35e1c181473cbdf42.patch

---

diff --git a/src/modules/tls/doc/params.xml b/src/modules/tls/doc/params.xml
index 6ef2d4123f..6028642b5f 100644
--- a/src/modules/tls/doc/params.xml
+++ b/src/modules/tls/doc/params.xml
@@ -1241,6 +1241,39 @@ end
 	    </example>
 	</section>
 
+	<section id="tls.p.rand_engine">
+	<title><varname>rand_engine</varname> (str)</title>
+	<para>
+		Set the ranondom number generator engine for libssl.
+	</para>
+	<para>
+		Note: the default random number generator (PRNG) engine of libssl v1.1.x
+		is not designed for multi-process applications and can result in a crash.
+		Therefore set the PRNG engine to one of the options listed in this
+		section. If libssl 1.1.x (or newer) is detected at compile time, then
+		the PRNG engine is set to "fastrand".
+	</para>
+	<para>
+		The following options are avaialble:
+	</para>
+	<itemizedlist>
+		<listitem><para>krand - use internal kam_rand() function</para></listitem>
+		<listitem><para>fastrand - use internal fastrand function</para></listitem>
+	</itemizedlist>
+	<para>
+		The default value is empty (not set) for libssl v1.0.x or older, and
+		"fastrand" for libssl v1.1.x or newer.
+	</para>
+	<example>
+	    <title>Set <varname>rand_engine</varname> parameter</title>
+	    <programlisting>
+...
+modparam("tls", "rand_engine", "fastrand")
+...
+	    </programlisting>
+	</example>
+	</section>
+
 	<section id="tls.p.engine">
 	<title><varname>engine</varname> (string)</title>
 	<para>