Browse Source

auth: set ids for elements in the documentation

- split checks parameters in own section for easier reference
Daniel-Constantin Mierla 12 years ago
parent
commit
678ab42506
3 changed files with 379 additions and 371 deletions
  1. 338 340
      modules/auth/README
  2. 9 9
      modules/auth/doc/auth_functions.xml
  3. 32 22
      modules/auth/doc/auth_params.xml

File diff suppressed because it is too large
+ 338 - 340
modules/auth/README


+ 9 - 9
modules/auth/doc/auth_functions.xml

@@ -6,7 +6,7 @@
 
     <title>Functions</title>
     
-    <section id="consume_credentials">
+    <section id="auth.f.consume_credentials">
 	<title><function>consume_credentials()</function></title>
 	<para>
 	    This function removes previously authorized credential headers from the
@@ -31,7 +31,7 @@ if (www_authenticate("realm", "subscriber")) {
 	    </programlisting>
 	</example>
     </section>
-    <section id="has_credentials">
+    <section id="auth.f.has_credentials">
 	<title><function>has_credentials(realm)</function></title>
 	<para>
 		This function returns true of the request has Autorization or
@@ -49,7 +49,7 @@ if (has_credentials("myrealm")) {
 	    </programlisting>
 	</example>
     </section>
-	<section id="www_challenge">
+	<section id="auth.f.www_challenge">
 		<title>
 			<function moreinfo="none">www_challenge(realm, flags)</function>
 		</title>
@@ -122,7 +122,7 @@ if (!www_authenticate("$td", "subscriber")) {
 		</example>
 	</section>
 
-	<section id="proxy_challenge">
+	<section id="auth.f.proxy_challenge">
 		<title>
 			<function moreinfo="none">proxy_challenge(realm, flags)</function>
 		</title>
@@ -152,7 +152,7 @@ if (!proxy_authenticate("$fd", "subscriber")) {
 		</example>
 	</section>
 
-	<section id="auth_challenge">
+	<section id="auth.f.auth_challenge">
 		<title>
 			<function moreinfo="none">auth_challenge(realm, flags)</function>
 		</title>
@@ -179,7 +179,7 @@ if (!auth_check("$fd", "subscriber", "1")) {
 		</example>
 	</section>
 
-	<section id="pv_www_authenticate">
+	<section id="auth.f.pv_www_authenticate">
 		<title>
 		<function moreinfo="none">pv_www_authenticate(realm, passwd, flags [, method])</function>
 		</title>
@@ -297,7 +297,7 @@ if (!pv_www_authenticate("$td", "123abc", "0")) {
 		</example>
 	</section>
 
-	<section id="pv_proxy_authenticate">
+	<section id="auth.f.pv_proxy_authenticate">
 		<title>
 			<function moreinfo="none">pv_proxy_authenticate(realm, passwd, flags)</function>
 		</title>
@@ -331,7 +331,7 @@ if (!pv_proxy_authenticate("$fd", "$avp(password)", "0")) {
 		</example>
 	</section>
 
-	<section id="pv_auth_check">
+	<section id="auth.f.pv_auth_check">
 		<title>
 			<function moreinfo="none">pv_auth_check(realm, passwd, flags, checks)</function>
 		</title>
@@ -368,7 +368,7 @@ if (!pv_auth_check("$fd", "$avp(password)", "0", "1")) {
 		</example>
 	</section>
 
-	<section id="auth_get_www_authenticate">
+	<section id="auth.f.auth_get_www_authenticate">
 		<title>
 			<function moreinfo="none">auth_get_www_authenticate(realm, flags, pvdest)</function>
 		</title>

+ 32 - 22
modules/auth/doc/auth_params.xml

@@ -6,14 +6,24 @@
 
     <title>Parameters</title>
     
-    <section id="auth.auth_checks">
-	<title>
-	  <varname>auth_checks_register</varname>,
-	  <varname>auth_checks_no_dlg</varname>, and
-	  <varname>auth_checks_in_dlg</varname> (flags)
-	</title>
-	<para>
-	These three module parameters control which optional integrity
+    <section id="auth.p.auth_checks_register">
+	<title><varname>auth_checks_register</varname> (flags)</title>
+	<para>
+		See description of parameter <varname>auth_checks_in_dlg</varname>.
+	</para>
+	</section>
+
+    <section id="auth.p.auth_checks_no_dlg">
+	<title><varname>auth_checks_no_dlg</varname> (flags)</title>
+	<para>
+		See description of parameter <varname>auth_checks_in_dlg</varname>.
+	</para>
+	</section>
+
+    <section id="auth.p.auth_checks_in_dlg">
+		<title><varname>auth_checks_in_dlg</varname> (flags)</title>
+	<para>
+		These three module parameters control which optional integrity
         checks will be performed on the SIP message carrying digest response
         during digest authentication. <varname>auth_check_register</varname>
         controls integrity checks to be performed on REGISTER messages,
@@ -125,7 +135,7 @@ modparam("auth", "auth_checks_in_dlg", 15)
 	</example>
     </section>
 
-    <section id="qop">
+    <section id="auth.p.qop">
 	<title><varname>qop</varname> (string)</title>
 	<para>
 		If set, enable <emphasis>qop</emphasis> for challenges: each challenge
@@ -161,7 +171,7 @@ modparam("auth", "qop", "auth")   # set qop=auth
 	</example>
     </section>
 
-    <section id="nonce_count">
+    <section id="auth.p.nonce_count">
 	<title><varname>nonce_count</varname> (boolean)</title>
 	<para>
 		If enabled the received <emphasis>nc</emphasis> value is remembered 
@@ -285,7 +295,7 @@ route{
 	</example>
     </section>
 
-	<section id="one_time_nonce">
+	<section id="auth.p.one_time_nonce">
 	<title><varname>one_time_nonce</varname> (boolean)</title>
 	<para>
 		If set to 1 nonce reuse is disabled: each nonce is allowed only once,
@@ -352,7 +362,7 @@ modparam("auth", "one_time_nonce", 1)
 	</example>
 	</section>
 
-    <section id="nid_pool_no">
+    <section id="auth.p.nid_pool_no">
 	<title><varname>nid_pool_no</varname> (integer)</title>
 	<para>
 		Controls the number of partitions for the 
@@ -404,7 +414,7 @@ modparam("auth", "nid_pool_no", 4)
 	</example>
     </section>
 
-    <section id="nc_array_size">
+    <section id="auth.p.nc_array_size">
 	<title><varname>nc_array_size</varname> (integer)</title>
 	<para>
 		Maximum number of in-flight nonces for <varname>nonce_count</varname>.
@@ -443,7 +453,7 @@ modparam("auth", "nc_array_size", 4194304)   # 4Mb
 	</example>
     </section>
 
-    <section id="nc_array_order">
+    <section id="auth.p.nc_array_order">
 	<title><varname>nc_array_order</varname> (integer)</title>
 	<para>
 		Equivalent to <varname>nc_array_size</varname>, but instead of 
@@ -473,7 +483,7 @@ modparam("auth", "nc_array_order", 22)   # 4Mb
 	</example>
     </section>
 
-    <section id="otn_in_flight_no">
+    <section id="auth.p.otn_in_flight_no">
 	<title><varname>otn_in_flight_no</varname> (integer)</title>
 	<para>
 		Maximum number of in-flight nonces for 
@@ -515,7 +525,7 @@ modparam("auth", "otn_in_flight_no", 8388608)   # 8 Mb (1Mb memory)
 	</example>
     </section>
 
-    <section id="otn_in_flight_order">
+    <section id="auth.p.otn_in_flight_order">
 	<title><varname>otn_in_flight_order</varname> (integer)</title>
 	<para>
 		Equivalent to <varname>otn_in_flight_no</varname>, but instead of
@@ -546,7 +556,7 @@ modparam("auth", "otn_in_flight_order", 23)   # 8 Mb (1Mb memory)
 	</example>
     </section>
 
-    <section id="auth.secret">
+    <section id="auth.p.secret">
 	<title><varname>secret</varname> (string)</title>
 	<para>Secret phrase used to calculate the nonce value used to challenge
 	the client for authentication.</para>
@@ -571,7 +581,7 @@ modparam("auth", "secret", "johndoessecretphrase")
 	</example>
     </section>
 
-    <section id="nonce_expire">
+    <section id="auth.p.nonce_expire">
 	<title><varname>nonce_expire</varname> (integer)</title>
 	<para>
 	    Nonces have limited lifetime. After a given period of time nonces
@@ -596,7 +606,7 @@ modparam("auth", "nonce_expire", 600)   # Set nonce_expire to 600s
 	</example>
     </section>
 
-	<section id="nonce_auth_max_drift">
+	<section id="auth.p.nonce_auth_max_drift">
 	<title><varname>nonce_auth_max_drift</varname> (integer)</title>
 	<para>
 		Maximum difference in seconds between a nonce creation time and the
@@ -628,7 +638,7 @@ modparam("auth", "nonce_auth_max_drift", 1)   # set max drift to 1 s
 	</example>
     </section>
 
-	<section id="force_stateless_reply">
+	<section id="auth.p.force_stateless_reply">
 	<title><varname>force_stateless_reply</varname> (boolean)</title>
 	<para>
 		If set to 1, <function>www_challenge()</function> and
@@ -647,7 +657,7 @@ modparam("auth", "force_stateless_reply", 1)
 	</example>
 	</section>
 
-	<section id="realm_prefix">
+	<section id="auth.p.realm_prefix">
 		<title><varname>realm_prefix</varname> (string)</title>
 		<para>
 			Prefix to be automatically strip from realm. As an alternative to
@@ -669,7 +679,7 @@ modparam("auth", "realm_prefix", "sip.")
 		</example>
 	</section>
 
-	<section id="auth.use_domain">
+	<section id="auth.p.use_domain">
 	<title><varname>use_domain</varname> (boolean)</title>
 	<para>
 		If set to 1, <function>pv_auth_check()</function> uses

Some files were not shown because too many files changed in this diff