res_pjsip: Update authenticate_qualify documentation.

Change-Id: I3811de0014b1ffe96d4a3b49cddd5d4ca02ee5d4

diff --git a/include/asterisk/res_pjsip.h b/include/asterisk/res_pjsip.h
index 2a7eb0a09e3649864466abcab8306ad5dd99ab1c..2acdf6f84b928510741f4b56f264b9421e5fe41d 100644 (file)
--- a/include/asterisk/res_pjsip.h
+++ b/include/asterisk/res_pjsip.h
@@ -263,7 +263,7 @@ struct ast_sip_contact {
        struct timeval expiration_time;
        /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
        unsigned int qualify_frequency;
-       /*! If true authenticate the qualify if needed */
+       /*! If true authenticate the qualify challenge response if needed */
        int authenticate_qualify;
        /*! Qualify timeout. 0 is diabled. */
        double qualify_timeout;
@@ -342,7 +342,7 @@ struct ast_sip_aor {
        unsigned int default_expiration;
        /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
        unsigned int qualify_frequency;
-       /*! If true authenticate the qualify if needed */
+       /*! If true authenticate the qualify challenge response if needed */
        int authenticate_qualify;
        /*! Maximum number of external contacts, 0 to disable */
        unsigned int max_contacts;

diff --git a/res/res_pjsip.c b/res/res_pjsip.c
index 277606bb79a0b246f9e66606a044281ca200a1cf..9ec00327d00a0009ac59d0812d54f50550d120e3 100644 (file)
--- a/res/res_pjsip.c
+++ b/res/res_pjsip.c
@@ -1366,12 +1366,17 @@
                                                If <literal>0</literal> no timeout. Time in fractional seconds.
                                        </para></description>
                                </configOption>
-                               <configOption name="authenticate_qualify" default="no">
-                                       <synopsis>Authenticates a qualify request if needed</synopsis>
-                                       <description><para>
-                                               If true and a qualify request receives a challenge or authenticate response
+                               <configOption name="authenticate_qualify">
+                                       <synopsis>Authenticates a qualify challenge response if needed</synopsis>
+                                       <description>
+                                               <para>If true and a qualify request receives a challenge response then
                                                authentication is attempted before declaring the contact available.
-                                       </para></description>
+                                               </para>
+                                               <note><para>This option does nothing as we will always complete
+                                               the challenge response authentication if the qualify request is
+                                               challenged.
+                                               </para></note>
+                                       </description>
                                </configOption>
                                <configOption name="outbound_proxy">
                                        <synopsis>Outbound proxy used when sending OPTIONS request</synopsis>
@@ -1565,12 +1570,17 @@
                                                If <literal>0</literal> no timeout. Time in fractional seconds.
                                        </para></description>
                                </configOption>
-                               <configOption name="authenticate_qualify" default="no">
-                                       <synopsis>Authenticates a qualify request if needed</synopsis>
-                                       <description><para>
-                                               If true and a qualify request receives a challenge or authenticate response
+                               <configOption name="authenticate_qualify">
+                                       <synopsis>Authenticates a qualify challenge response if needed</synopsis>
+                                       <description>
+                                               <para>If true and a qualify request receives a challenge response then
                                                authentication is attempted before declaring the contact available.
-                                       </para></description>
+                                               </para>
+                                               <note><para>This option does nothing as we will always complete
+                                               the challenge response authentication if the qualify request is
+                                               challenged.
+                                               </para></note>
+                                       </description>
                                </configOption>
                                <configOption name="outbound_proxy">
                                        <synopsis>Outbound proxy used when sending OPTIONS request</synopsis>