[sr-dev] git:master:f012c525: db_mysql: docs for opt_ssl_mode parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: f012c525264ed05fec2acb4b3924d4b9a1cd3ab9
URL: https://github.com/kamailio/kamailio/commit/f012c525264ed05fec2acb4b3924d4b9a1cd3ab9

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-06-14T11:31:59+02:00

db_mysql: docs for opt_ssl_mode parameter

---

Modified: src/modules/db_mysql/doc/db_mysql_admin.xml

---

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

---

diff --git a/src/modules/db_mysql/doc/db_mysql_admin.xml b/src/modules/db_mysql/doc/db_mysql_admin.xml
index 26e32d8d36..68deb56cab 100644
--- a/src/modules/db_mysql/doc/db_mysql_admin.xml
+++ b/src/modules/db_mysql/doc/db_mysql_admin.xml
@@ -182,6 +182,36 @@ modparam("db_mysql", "update_affected_found", 1)
 		</example>
 	</section>
 	</section>
+	<section id="db_mysql.p.opt_ssl_mode">
+		<title><varname>opt_ssl_mode</varname> (integer)</title>
+		<para>
+		Control how the connection to MySQL server is done in regards to SSL/TLS.
+		If set to 1, SSL/TLS mode is disabled.
+		</para>
+		<para>
+		The 'include/mysql.h' starting with MySQL 5.7.11 defines the values for
+		this option as enum: 'mysql_ssl_mode { SSL_MODE_DISABLED=1, SSL_MODE_PREFERRED,
+		SSL_MODE_REQUIRED, SSL_MODE_VERIFY_CA, SSL_MODE_VERIFY_IDENTITY}'.
+		</para>
+		<para>
+		Note: if the value of this parameter is 1, it enforces SSL_MODE_DISABLED,
+		any other value is passed to the mysql_options(), not checking if it is
+		defined.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 0 (0 - off).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>opt_ssl_mode</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("db_mysql", "opt_ssl_mode", 1)
+...
+</programlisting>
+		</example>
+	</section>
 	<section>
 	<title>Functions</title>
 		<para>