Module: kamailio
Branch: master
Commit: 0868ed0ef12e65c7790beeccf139b5fdc245efdb
URL:
https://github.com/kamailio/kamailio/commit/0868ed0ef12e65c7790beeccf139b5f…
Author: Camille Oudot <camille.oudot(a)orange.com>
Committer: Camille Oudot <camille.oudot(a)orange.com>
Date: 2015-08-12T17:33:00+02:00
auth: modify doc to reflect current implementation
---
Modified: modules/auth/doc/auth_functions.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/0868ed0ef12e65c7790beeccf139b5f…
Patch:
https://github.com/kamailio/kamailio/commit/0868ed0ef12e65c7790beeccf139b5f…
---
diff --git a/modules/auth/doc/auth_functions.xml b/modules/auth/doc/auth_functions.xml
index ec33324..225dbb3 100644
--- a/modules/auth/doc/auth_functions.xml
+++ b/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>