Module: kamailio
Branch: master
Commit: 4e2c3f2b41859767f13bef237b93ea7101f36d12
URL:
https://github.com/kamailio/kamailio/commit/4e2c3f2b41859767f13bef237b93ea7…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2017-09-26T10:06:36+02:00
auth: explicit listing of status codes for replies in docs of challenge functions
---
Modified: src/modules/auth/doc/auth_functions.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/4e2c3f2b41859767f13bef237b93ea7…
Patch:
https://github.com/kamailio/kamailio/commit/4e2c3f2b41859767f13bef237b93ea7…
---
diff --git a/src/modules/auth/doc/auth_functions.xml
b/src/modules/auth/doc/auth_functions.xml
index 4bce4e5510..0f56d0b0b7 100644
--- a/src/modules/auth/doc/auth_functions.xml
+++ b/src/modules/auth/doc/auth_functions.xml
@@ -63,10 +63,10 @@ if (has_credentials("myrealm")) {
The function challenges a user agent. It will generate a
WWW-Authorize header field containing a digest challenge, it will
put the header field into a response generated from the request the
- server is processing and send the reply. Upon reception of such a
+ server is processing and send the 401 reply. Upon reception of such a
reply the user agent should compute credentials and retry the
request. For more information regarding digest authentication
- see RFC2617. See module parameter force_stateless_reply
+ see RFC2617. See module parameter force_stateless_reply
regarding sending of the reply.
</para>
<para>Meaning of the parameters is as follows:</para>
@@ -136,7 +136,7 @@ if (!www_authenticate("$td", "subscriber")) {
The function challenges a user agent. It will generate a
Proxy-Authorize header field containing a digest challenge, it will
put the header field into a response generated from the request the
- server is processing and send the reply. Upon reception of such a
+ server is processing and send the 407 reply. Upon reception of such a
reply the user agent should compute credentials and retry the request.
For more information regarding digest authentication see RFC2617.
See module parameter force_stateless_reply regarding sending of the reply.
@@ -166,7 +166,9 @@ if (!proxy_authenticate("$fd", "subscriber")) {
The function challenges a user agent for authentication. It combines
the functions www_challenge() and proxy_challenge(), by calling
internally the first one for REGISTER requests and the second one for
- the rest of other request types.
+ the rest of other request types. In other words, it challenges for
+ authentication by sending a 401 reply for REGISTER requests and 407
+ reply for the other types of SIP requests.
</para>
<para>Meaning of the parameters the same as for function
www_challenge(realm, flags)</para>