Browse Source

auth: modify doc to reflect current implementation

Camille Oudot 10 years ago
parent
commit
0868ed0ef1
1 changed files with 7 additions and 8 deletions
  1. 7 8
      modules/auth/doc/auth_functions.xml

+ 7 - 8
modules/auth/doc/auth_functions.xml

@@ -204,10 +204,6 @@ if (!auth_check("$fd", "subscriber", "1")) {
 			<emphasis>-2 (invalid password)</emphasis> - wrong password
 			</para></listitem>
 			<listitem><para>
-			<emphasis>-3 (invalid user)</emphasis> - authentication user does
-			not exist
-			</para></listitem>
-			<listitem><para>
 			<emphasis>-4 (nonce expired)</emphasis> - the nonce has expired
 			</para></listitem>
 			<listitem><para>
@@ -218,10 +214,6 @@ if (!auth_check("$fd", "subscriber", "1")) {
 			<emphasis>-6 (nonce reused)</emphasis> - the nonce has already been
 			used to authenticate a previous request
 			</para></listitem>
-			<listitem><para>
-			<emphasis>-8 (auth user mismatch)</emphasis> - the auth user is different
-			then the From/To user
-			</para></listitem>
 		</itemizedlist>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
@@ -357,6 +349,13 @@ if (!pv_proxy_authenticate("$fd", "$avp(password)", "0")) {
 		request or not.	The parameter may be a pseudo variable.
 		</para>
 		<para>
+		The set of possible return codes is the same than pv_{www,proxy}_authenticate, with
+		one more possible value:
+		    <para><emphasis>-8 (auth user mismatch)</emphasis> - the auth user is different
+               than the From/To user
+			</para>
+		</para>
+		<para>
 		This function can be used from REQUEST_ROUTE.
 		</para>
 		<example>