Browse Source

uac: updated docs for uac_auth()

Daniel-Constantin Mierla 5 years ago
parent
commit
825800e6d3
1 changed files with 8 additions and 2 deletions
  1. 8 2
      src/modules/uac/doc/uac_admin.xml

+ 8 - 2
src/modules/uac/doc/uac_admin.xml

@@ -802,14 +802,18 @@ uac_restore_to();
 		</section>
 		</section>
 		<section id="uac.f.uac_auth">
 		<section id="uac.f.uac_auth">
 			<title>
 			<title>
-				<function moreinfo="none">uac_auth()</function>
+				<function moreinfo="none">uac_auth([mode])</function>
 			</title>
 			</title>
 			<para>
 			<para>
-			This function can be called only from failure route and will 
+			This function can be called only from failure route and will
 			build the authentication response header and insert it into the
 			build the authentication response header and insert it into the
 			request without sending anything.
 			request without sending anything.
 			</para>
 			</para>
 			<para>
 			<para>
+			If mode is set to 1, then the password has to be provided in HA1 format.
+			The parameter can be a static integer or a variable holding an integer value.
+			</para>
+			<para>
 			This function can be used from FAILURE_ROUTE.
 			This function can be used from FAILURE_ROUTE.
 			</para>
 			</para>
 			<example>
 			<example>
@@ -836,7 +840,9 @@ failure_route[TRUNKAUTH] {
     if(t_check_status("401|407")) {
     if(t_check_status("401|407")) {
         $avp(auser) = "test";
         $avp(auser) = "test";
         $avp(apass) = "test";
         $avp(apass) = "test";
+        # $avp(apass) = "36d0a02793542b4961e8348347236dbf";
         uac_auth();
         uac_auth();
+        # uac_auth("1");
         t_relay();
         t_relay();
         exit;
         exit;
     }
     }