[sr-dev] git:5.0:826b3cab: topoh: documented uri_prefix_checks parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 5.0
Commit: 826b3cab606fb51c7139fe81463aeb2409f40b67
URL: https://github.com/kamailio/kamailio/commit/826b3cab606fb51c7139fe81463aeb2409f40b67

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-06-25T10:14:52+02:00

topoh: documented uri_prefix_checks parameter

(cherry picked from commit ca3f2fc6dd2c94410b225d2efb82081b828ddd01)

---

Modified: src/modules/topoh/doc/topoh_admin.xml

---

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

---

diff --git a/src/modules/topoh/doc/topoh_admin.xml b/src/modules/topoh/doc/topoh_admin.xml
index 2d92f21e47..83850d277c 100644
--- a/src/modules/topoh/doc/topoh_admin.xml
+++ b/src/modules/topoh/doc/topoh_admin.xml
@@ -10,9 +10,9 @@
 <!-- Module User's Guide -->
 
 <chapter>
-	
+
 	<title>&adminguide;</title>
-	
+
 	<section>
 	<title>Overview</title>
 	<para>
@@ -253,7 +253,34 @@ modparam("topoh", "sanity_checks", 1)
 </programlisting>
 		</example>
 	</section>
-
+	<section>
+		<title><varname>uri_prefix_checks</varname> (integer)</title>
+		<para>
+			If set to 1, topoh module will check if URIs to be decoded match
+			the expected prefix composed from mask IP and parameter name prefix.
+			It can make the topoh processing safer by avoiding to try decoding
+			URIs which were not encoded previously by topoh.
+		</para>
+		<para>
+			Note: do not enable this option if you have SIP devices that can
+			alter the URI values it takes from Contact or Record-Route headers
+			(like adding port 5060 when no port is in received URIs, or
+			thet introduce new parameters at unknown position).
+		</para>
+		<para>
+		<emphasis>
+			Default value is 0.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>uri_prefix_checks</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("topoh", "uri_prefix_checks", 1)
+...
+</programlisting>
+		</example>
+	</section>
 	</section>
 </chapter>