[sr-dev] git:4.3:48d78ce8: auth: modify doc to reflect current implementation
Camille Oudot
camille.oudot at orange.com
Wed Aug 12 17:40:53 CEST 2015
Module: kamailio
Branch: 4.3
Commit: 48d78ce87e2f42bdc77e688a0f45ff725ea97de5
URL: https://github.com/kamailio/kamailio/commit/48d78ce87e2f42bdc77e688a0f45ff725ea97de5
Author: Camille Oudot <camille.oudot at orange.com>
Committer: Camille Oudot <camille.oudot at orange.com>
Date: 2015-08-12T17:40:24+02:00
auth: modify doc to reflect current implementation
(cherry picked from commit 0868ed0ef12e65c7790beeccf139b5fdc245efdb)
---
Modified: modules/auth/doc/auth_functions.xml
---
Diff: https://github.com/kamailio/kamailio/commit/48d78ce87e2f42bdc77e688a0f45ff725ea97de5.diff
Patch: https://github.com/kamailio/kamailio/commit/48d78ce87e2f42bdc77e688a0f45ff725ea97de5.patch
---
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>
More information about the sr-dev
mailing list