Changeset 4173

Timestamp:

Jun 20, 2012 10:39:05 AM (12 years ago)

Author:

ming

Message:

Fixed #1537: Via rewrite: putting the right IP address in Via sent-by for outgoing requests

Location:

pjproject/trunk/pjsip

Files:

• include/pjsip-simple/publish.h (modified) (1 diff)
• include/pjsip-ua/sip_regc.h (modified) (1 diff)
• include/pjsip/sip_dialog.h (modified) (3 diffs)
• include/pjsip/sip_transport.h (modified) (1 diff)
• include/pjsua-lib/pjsua.h (modified) (1 diff)
• include/pjsua-lib/pjsua_internal.h (modified) (1 diff)
• src/pjsip-simple/publishc.c (modified) (3 diffs)
• src/pjsip-ua/sip_reg.c (modified) (3 diffs)
• src/pjsip/sip_dialog.c (modified) (2 diffs)
• src/pjsip/sip_util.c (modified) (1 diff)
• src/pjsua-lib/pjsua_acc.c (modified) (5 diffs)
• src/pjsua-lib/pjsua_call.c (modified) (2 diffs)
• src/pjsua-lib/pjsua_core.c (modified) (1 diff)
• src/pjsua-lib/pjsua_im.c (modified) (2 diffs)
• src/pjsua-lib/pjsua_pres.c (modified) (4 diffs)

pjproject/trunk/pjsip/include/pjsip-simple/publish.h

@@ -238 +238 @@
 
 /**
+ * Set the "sent-by" field of the Via header for outgoing requests.
+ *
+ * @param pubc      The client publication structure.
+ * @param via_addr  Set via_addr to use for the Via header or NULL to use
+ *                  the transport's published name.
+ * @param via_tp    via_addr will only be used if we are using via_tp
+ *                  transport.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_publishc_set_via_sent_by(pjsip_publishc *pubc,
+                                                    pjsip_host_port *via_addr,
+                                                    pjsip_transport *via_tp);
+
+
+/**
  * Create PUBLISH request for the specified client publication structure.
  * Application can use this function to both create initial publication

pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h

@@ -192 +192 @@
 
 /**
+ * Set the "sent-by" field of the Via header for outgoing requests.
+ *
+ * @param regc      The client registration structure.
+ * @param via_addr  Set via_addr to use for the Via header or NULL to use
+ *                  the transport's published name.
+ * @param via_tp    via_addr will only be used if we are using via_tp
+ *                  transport.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_regc_set_via_sent_by(pjsip_regc *regc,
+                                                pjsip_host_port *via_addr,
+                                                pjsip_transport *via_tp);
+
+/**
  * Set the number of seconds to refresh the client registration before
  * the registration expires.

pjproject/trunk/pjsip/include/pjsip/sip_dialog.h

@@ -174 +174 @@
     /** Module specific data. */
     void               *mod_data[PJSIP_MAX_MODULE]; /**< Module data.       */
+
+    /**
+     * If via_addr is set, it will be used as the "sent-by" field of the
+     * Via header for outgoing requests as long as the request uses via_tp
+     * transport. Normally application should not use or access these fields.
+     */
+    pjsip_host_port     via_addr;   /**< Via address.                       */
+    const void         *via_tp;     /**< Via transport.                     */
 };
 
@@ -299 +307 @@
 
 /**
+ * Set the "sent-by" field of the Via header for outgoing requests.
+ *
+ * @param dlg       The dialog instance.
+ * @param via_addr  Set via_addr to use for the Via header or NULL to use
+ *                  the transport's published name.
+ * @param via_tp    via_addr will only be used if we are using via_tp
+ *                  transport.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_dlg_set_via_sent_by(pjsip_dialog *dlg,
+                                               pjsip_host_port *via_addr,
+                                               pjsip_transport *via_tp);
+
+
+/**
  * Create a new (forked) dialog on receipt on forked response in rdata. 
  * The new dialog will be created from original_dlg, except that it will have
@@ -403 +427 @@
  */
 PJ_DECL(pj_bool_t) pjsip_dlg_has_usage(pjsip_dialog *dlg,
-                                          pjsip_module *module);
+                                       pjsip_module *module);
 
 /**

pjproject/trunk/pjsip/include/pjsip/sip_transport.h

@@ -585 +585 @@
      */
     void                    *mod_data[PJSIP_MAX_MODULE];
+
+    /**
+     * If via_addr is set, it will be used as the "sent-by" field of the
+     * Via header for outgoing requests as long as the request uses via_tp
+     * transport. Normally application should not use or access these fields.
+     */
+    pjsip_host_port          via_addr;      /**< Via address.           */
+    const void              *via_tp;        /**< Via transport.         */
 };
 

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -2819 +2819 @@
 
     /**
+     * This option is used to overwrite the "sent-by" field of the Via header
+     * for outgoing messages with the same interface address as the one in
+     * the REGISTER request, as long as the request uses the same transport
+     * instance as the previous REGISTER request.
+     *
+     * Default: 1 (yes)
+     */
+    pj_bool_t        allow_via_rewrite;
+
+    /**
      * Control the use of SIP outbound feature. SIP outbound is described in
      * RFC 5626 to enable proxies or registrar to send inbound requests back

pjproject/trunk/pjsip/include/pjsua-lib/pjsua_internal.h

@@ -213 +213 @@
                                          It may be different than acc
                                          contact if outbound is used    */
+    pjsip_host_port  via_addr;      /**< Address for Via header         */
+    pjsip_transport *via_tp;        /**< Transport associated with
+                                         the Via address                */
 
     pj_str_t         srv_domain;    /**< Host part of reg server.       */

pjproject/trunk/pjsip/src/pjsip-simple/publishc.c

@@ -95 +95 @@
     pjsip_route_hdr              route_set;
     pjsip_hdr                    usr_hdr;
+    pjsip_host_port              via_addr;
+    const void                  *via_tp;
 
     /* Authorization sessions. */
@@ -342 +344 @@
         h = h->next;
     }
+
+    return PJ_SUCCESS;
+}
+
+PJ_DEF(pj_status_t) pjsip_publishc_set_via_sent_by(pjsip_publishc *pubc,
+                                                   pjsip_host_port *via_addr,
+                                                   pjsip_transport *via_tp)
+{
+    PJ_ASSERT_RETURN(pubc, PJ_EINVAL);
+
+    if (!via_addr)
+        pj_bzero(&pubc->via_addr, sizeof(pubc->via_addr));
+    else
+        pubc->via_addr = *via_addr;
+    pubc->via_tp = via_tp;
 
     return PJ_SUCCESS;
@@ -740 +757 @@
     pj_mutex_unlock(pubc->mutex);
 
+    /* If via_addr is set, use this address for the Via header. */
+    if (pubc->via_addr.host.slen > 0) {
+        tdata->via_addr = pubc->via_addr;
+        tdata->via_tp = pubc->via_tp;
+    }
+
     /* Invalidate message buffer. */
     pjsip_tx_data_invalidate_msg(tdata);

pjproject/trunk/pjsip/src/pjsip-ua/sip_reg.c

@@ -91 +91 @@
     pjsip_route_hdr              route_set;
     pjsip_hdr                    hdr_list;
+    pjsip_host_port              via_addr;
+    const void                  *via_tp;
 
     /* Authorization sessions. */
@@ -807 +809 @@
         regc->next_reg.sec += delay.sec;
     }
+}
+
+PJ_DEF(pj_status_t) pjsip_regc_set_via_sent_by( pjsip_regc *regc,
+                                                pjsip_host_port *via_addr,
+                                                pjsip_transport *via_tp)
+{
+    PJ_ASSERT_RETURN(regc, PJ_EINVAL);
+
+    if (!via_addr)
+        pj_bzero(&regc->via_addr, sizeof(regc->via_addr));
+    else
+        regc->via_addr = *via_addr;
+    regc->via_tp = via_tp;
+
+    return PJ_SUCCESS;
 }
 
@@ -1263 +1280 @@
     pjsip_tx_data_add_ref(tdata);
 
+    /* If via_addr is set, use this address for the Via header. */
+    if (regc->via_addr.host.slen > 0) {
+        tdata->via_addr = regc->via_addr;
+        tdata->via_tp = regc->via_tp;
+    }
+
     /* Need to unlock the regc temporarily while sending the message to
      * prevent deadlock (https://trac.pjsip.org/repos/ticket/1247).

pjproject/trunk/pjsip/src/pjsip/sip_dialog.c

@@ -586 +586 @@
 }
 
+/*
+ * Set "sent-by" field of Via header.
+ */
+PJ_DEF(pj_status_t) pjsip_dlg_set_via_sent_by( pjsip_dialog *dlg,
+                                               pjsip_host_port *via_addr,
+                                               pjsip_transport *via_tp)
+{
+    PJ_ASSERT_RETURN(dlg, PJ_EINVAL);
+
+    if (!via_addr)
+        pj_bzero(&dlg->via_addr, sizeof(dlg->via_addr));
+    else
+        dlg->via_addr = *via_addr;
+    dlg->via_tp = via_tp;
+
+    return PJ_SUCCESS;
+}
+
 
 /*
@@ -1163 +1181 @@
     /* Lock and increment session */
     pjsip_dlg_inc_lock(dlg);
+
+    /* If via_addr is set, use this address for the Via header. */
+    if (dlg->via_addr.host.slen > 0) {
+        tdata->via_addr = dlg->via_addr;
+        tdata->via_tp = dlg->via_tp;
+    }
 
     /* Update dialog's CSeq and message's CSeq if request is not

pjproject/trunk/pjsip/src/pjsip/sip_util.c

@@ -1193 +1193 @@
 
         via->transport = pj_str(stateless_data->cur_transport->type_name);
-        via->sent_by = stateless_data->cur_transport->local_name;
+        if (tdata->via_addr.host.slen > 0 &&
+            tdata->via_tp == (void *)stateless_data->cur_transport)
+        {
+            via->sent_by = tdata->via_addr;
+        } else {
+            via->sent_by = stateless_data->cur_transport->local_name;
+        }
         via->rport_param = pjsip_cfg()->endpt.disable_rport ? -1 : 0;
 

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_acc.c

@@ -625 +625 @@
     acc->valid = PJ_FALSE;
     acc->contact.slen = 0;
+    pj_bzero(&acc->via_addr, sizeof(acc->via_addr));
+    acc->via_tp = NULL;
 
     /* Remove from array */
@@ -1091 +1093 @@
     }
 
+    /* Allow via rewrite */
+    if (acc->cfg.allow_via_rewrite != cfg->allow_via_rewrite) {
+        if (acc->regc != NULL) {
+            if (cfg->allow_via_rewrite) {
+                pjsip_regc_set_via_sent_by(acc->regc, &acc->via_addr,
+                                           acc->via_tp);
+            } else
+                pjsip_regc_set_via_sent_by(acc->regc, NULL, NULL);
+        }
+        if (acc->publish_sess != NULL) {
+            if (cfg->allow_via_rewrite) {
+                pjsip_publishc_set_via_sent_by(acc->publish_sess,
+                                               &acc->via_addr, acc->via_tp);
+            } else
+                pjsip_publishc_set_via_sent_by(acc->publish_sess, NULL, NULL);
+        }
+        acc->cfg.allow_via_rewrite = cfg->allow_via_rewrite;
+    }
+
     /* Normalize registration timeout and refresh delay */
     if (acc->cfg.reg_uri.slen ) {
@@ -1314 +1335 @@
 
     tp = param->rdata->tp_info.transport;
+
+    /* If allow_via_rewrite is enabled, we save the Via "sent-by" address
+     * from the response.
+     */
+    if (acc->cfg.allow_via_rewrite &&
+        (acc->via_addr.host.slen == 0 || acc->via_tp != tp))
+    {
+        via = param->rdata->msg_info.via;
+        if (pj_strcmp(&acc->via_addr.host, &via->sent_by.host))
+            pj_strdup(acc->pool, &acc->via_addr.host, &via->sent_by.host);
+        acc->via_addr.port = via->sent_by.port;
+        acc->via_tp = tp;
+    }
 
     /* Only update if account is configured to auto-update */
@@ -2177 +2211 @@
 
     if (status == PJ_SUCCESS) {
+        if (pjsua_var.acc[acc_id].cfg.allow_via_rewrite &&
+            pjsua_var.acc[acc_id].via_addr.host.slen > 0)
+        {
+            pjsip_regc_set_via_sent_by(pjsua_var.acc[acc_id].regc,
+                                       &pjsua_var.acc[acc_id].via_addr,
+                                       pjsua_var.acc[acc_id].via_tp);
+        }
+
         //pjsua_process_msg_data(tdata, NULL);
         status = pjsip_regc_send( pjsua_var.acc[acc_id].regc, tdata );
@@ -2540 +2582 @@
         pjsua_init_tpselector(acc->cfg.transport_id, &tp_sel);
         pjsip_tx_data_set_transport(tdata, &tp_sel);
+    }
+
+    /* If via_addr is set, use this address for the Via header. */
+    if (pjsua_var.acc[acc_id].cfg.allow_via_rewrite &&
+        pjsua_var.acc[acc_id].via_addr.host.slen > 0)
+    {
+        tdata->via_addr = pjsua_var.acc[acc_id].via_addr;
+        tdata->via_tp = pjsua_var.acc[acc_id].via_tp;
     }
 

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_call.c

@@ -716 +716 @@
     pjsip_dlg_inc_lock(dlg);
 
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0)
+        pjsip_dlg_set_via_sent_by(dlg, &acc->via_addr, acc->via_tp);
+
     /* Calculate call's secure level */
     call->secure_level = get_secure_level(acc_id, dest_uri);
@@ -1169 +1172 @@
                                       NULL, NULL);
         goto on_return;
+    }
+
+    if (pjsua_var.acc[acc_id].cfg.allow_via_rewrite &&
+        pjsua_var.acc[acc_id].via_addr.host.slen > 0)
+    {
+        pjsip_dlg_set_via_sent_by(dlg, &pjsua_var.acc[acc_id].via_addr,
+                                  pjsua_var.acc[acc_id].via_tp);
     }
 

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_core.c

@@ -212 +212 @@
     cfg->transport_id = PJSUA_INVALID_ID;
     cfg->allow_contact_rewrite = PJ_TRUE;
+    cfg->allow_via_rewrite = PJ_TRUE;
     cfg->require_100rel = pjsua_var.ua_cfg.require_100rel;
     cfg->use_timer = pjsua_var.ua_cfg.use_timer;

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_im.c

@@ -602 +602 @@
     pjsua_set_msg_route_set(tdata, &acc->route_set);
 
+    /* If via_addr is set, use this address for the Via header. */
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0) {
+        tdata->via_addr = acc->via_addr;
+        tdata->via_tp = acc->via_tp;
+    }
+
     /* Send request (statefully) */
     status = pjsip_endpt_send_request( pjsua_var.endpt, tdata, -1, 
@@ -685 +691 @@
     pjsua_set_msg_route_set(tdata, &acc->route_set);
 
+    /* If via_addr is set, use this address for the Via header. */
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0) {
+        tdata->via_addr = acc->via_addr;
+        tdata->via_tp = acc->via_tp;
+    }
+
     /* Create data to reauthenticate */
     im_data = PJ_POOL_ZALLOC_T(tdata->pool, pjsua_im_data);

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_pres.c

@@ -865 +865 @@
     }
 
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0)
+        pjsip_dlg_set_via_sent_by(dlg, &acc->via_addr, acc->via_tp);
+
     /* Set credentials and preference. */
     pjsip_auth_clt_set_credentials(&dlg->auth_sess, acc->cred_cnt, acc->cred);
@@ -1229 +1232 @@
     /* Add headers etc */
     pjsua_process_msg_data(tdata, NULL);
+
+    /* Set Via sent-by */
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0) {
+        pjsip_publishc_set_via_sent_by(acc->publish_sess, &acc->via_addr,
+                                       acc->via_tp);
+    }
 
     /* Send the PUBLISH request */
@@ -1781 +1790 @@
     pjsip_dlg_inc_lock(buddy->dlg);
 
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0)
+        pjsip_dlg_set_via_sent_by(buddy->dlg, &acc->via_addr, acc->via_tp);
+
     status = pjsip_pres_create_uac( buddy->dlg, &pres_callback, 
                                     PJSIP_EVSUB_NO_EVENT_ID, &buddy->sub);
@@ -2097 +2109 @@
      */
     pjsip_dlg_inc_lock(acc->mwi_dlg);
+
+    if (acc->cfg.allow_via_rewrite && acc->via_addr.host.slen > 0)
+        pjsip_dlg_set_via_sent_by(acc->mwi_dlg, &acc->via_addr, acc->via_tp);
 
     /* Create UAC subscription */