Browse code

tls: documentation for server_name and xavp_cfg

Daniel-Constantin Mierla authored on 17/02/2015 13:50:43
Showing 1 changed files
... ...
@@ -350,6 +350,28 @@ modparam("tls", "cipher_list", "HIGH")
350 350
 	</example>
351 351
 	</section>
352 352
 
353
+	<section id="tls.p.server_name">
354
+	<title><varname>server_name</varname> (string)</title>
355
+	<para>
356
+		Sets the Server Name Indication (SNI) value.
357
+	</para>
358
+	<para>
359
+		This is a TLS extension and is not working for old and obsoleted
360
+		SSL versions.
361
+	</para>
362
+	<para>
363
+		The default value is empty (not set).
364
+	</para>
365
+	<example>
366
+	    <title>Set <varname>server_name</varname> parameter</title>
367
+	    <programlisting>
368
+...
369
+modparam("tls", "server_name", "kamailio.org")
370
+...
371
+	    </programlisting>
372
+	</example>
373
+	</section>
374
+
353 375
 	<section id="tls.p.send_timeout">
354 376
 	<title><varname>send_timeout</varname> (int)</title>
355 377
 	<para>
... ...
@@ -993,6 +1015,7 @@ modparam("tls", "renegotiation", 1)
993 1015
 			<listitem><para>ca_list</para></listitem>
994 1016
 			<listitem><para>crl</para></listitem>
995 1017
 			<listitem><para>cipher_list</para></listitem>
1018
+			<listitem><para>server_name</para></listitem>
996 1019
 	</itemizedlist>
997 1020
 	<para>
998 1021
 		All the parameters that take filenames as values will be resolved
... ...
@@ -1031,6 +1054,7 @@ private_key = local_key.pem
1031 1054
 certificate = local_cert.pem
1032 1055
 verify_depth = 3
1033 1056
 ca_list = local_ca.pem
1057
+server_name = kamailio.org
1034 1058
 
1035 1059
 	</programlisting>
1036 1060
 	</example>
... ...
@@ -1058,4 +1082,32 @@ modparam("tls", "config", "/usr/local/etc/kamailio/tls.cfg")
1058 1082
 	</para>
1059 1083
 	</section>
1060 1084
 
1085
+	<section id="tls.p.xavp_cfg">
1086
+	<title><varname>xavp_cfg</varname> (string)</title>
1087
+	<para>
1088
+		Sets the name of XAVP that stored attributes for TLS connections.
1089
+	</para>
1090
+	<para>
1091
+		The following (inner) attributes can be set:
1092
+	</para>
1093
+	<itemizedlist>
1094
+		<listitem><para>server_name - SNI to be used for outbound connections</para></listitem>
1095
+	</itemizedlist>
1096
+	<para>
1097
+		The default value is empty (not set).
1098
+	</para>
1099
+	<example>
1100
+	    <title>Set <varname>xavp_cfg</varname> parameter</title>
1101
+	    <programlisting>
1102
+...
1103
+  modparam("tls", "xavp_cfg", "tls")
1104
+ ...
1105
+  $xavp(tls=>server_name) = "kamailio.org";
1106
+  $du = "sip:kamailio.org:5061;transport=tls";
1107
+  route(RELAY);
1108
+...
1109
+	    </programlisting>
1110
+	</example>
1111
+	</section>
1112
+
1061 1113
 </section>