[sr-dev] git:master: auth: document '-8' return code for pv_www_authenticate

[Ovidiu Sas]

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

Author: Ovidiu Sas <osas at voipembedded.com>
Committer: Ovidiu Sas <osas at voipembedded.com>
Date:   Tue Jun 17 11:47:50 2014 -0400

auth: document '-8' return code for pv_www_authenticate

---

 modules/auth/doc/auth_functions.xml |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/modules/auth/doc/auth_functions.xml b/modules/auth/doc/auth_functions.xml
index 0ab616a..ec33324 100644
--- a/modules/auth/doc/auth_functions.xml
+++ b/modules/auth/doc/auth_functions.xml
@@ -198,26 +198,30 @@ if (!auth_check("$fd", "subscriber", "1")) {
 		<itemizedlist>
 			<listitem><para>
 			<emphasis>-1 (generic error)</emphasis> - some generic error
-			occurred and no reply was sent out;
+			occurred and no reply was sent out
 			</para></listitem>
 			<listitem><para>
-			<emphasis>-2 (invalid password)</emphasis> - wrong password;
+			<emphasis>-2 (invalid password)</emphasis> - wrong password
 			</para></listitem>
 			<listitem><para>
 			<emphasis>-3 (invalid user)</emphasis> - authentication user does
-			not exist.
+			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.
+			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 (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>