[sr-dev] git:master: modules/auth_db: document authentication return values

[Klaus Darilion]

Module: sip-router
Branch: master
Commit: 2940d5012250a134745a2cf9abed2f88ed95576e
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=2940d5012250a134745a2cf9abed2f88ed95576e

Author: Klaus Darilion <klaus.mailinglists at pernau.at>
Committer: Klaus Darilion <klaus.mailinglists at pernau.at>
Date:   Mon Jun  3 22:10:20 2013 +0000

modules/auth_db: document authentication return values

---

 modules/auth_db/doc/auth_db_admin.xml |   20 ++++++++++++++++++--
 1 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/modules/auth_db/doc/auth_db_admin.xml b/modules/auth_db/doc/auth_db_admin.xml
index 999c3cf..246d532 100644
--- a/modules/auth_db/doc/auth_db_admin.xml
+++ b/modules/auth_db/doc/auth_db_admin.xml
@@ -327,13 +327,27 @@ modparam("auth_db", "version_table", 0)
 			occurred and no reply was sent out;
 			</para></listitem>
 			<listitem><para>
-			<emphasis>-2 (invalid password)</emphasis> - valid user, but 
-			wrong password;
+			<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>
+			<emphasis>-5 (no credentials)</emphasis> - request does not contain
+			an Authorization header with the correct realm.
+			</para></listitem>
+			<listitem><para>
+			<emphasis>-6 (nonce reused)</emphasis> - the nonce has already been
+			used to authenticate a previous request
+			</para></listitem>
+			<listitem><para>
+			<emphasis>-8 (authuser mismatch)</emphasis> - depending on the method, th
+			From/To/RURI user does not match the authentication user (see auth_check() function).
+			</para></listitem>
 		</itemizedlist>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
@@ -479,6 +493,8 @@ if (!proxy_authorize("$fd", "subscriber)) {
 		the function checks if authentication username matches From/To header
 		username, and Request-URI in case of PUBLISH.
 		</para>
+		<para>Negative return codes have the same meaning as for
+			www_authenticate().</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<listitem>